Files
speckle-sharp-sdk/.github/git-commit-instructions.md
Adam Hathcock 4dd6db886f insert or replace always...don't use ignore or insert (#363)
* SaveObject is always insert or replace.  Never use insert or ignore

* add/fix tests

* always replace even for bulk
2025-07-23 12:16:08 +00:00

860 B

Git Commit Instructions

To ensure high-quality and consistent commits, please follow these guidelines:

  1. Format your code

    • Run the csharpier formatter on all C# files before committing.
    • Ensure your code adheres to the .editorconfig settings.
  2. Write clear commit messages

    • Use the present tense ("Add feature" not "Added feature").
    • Start with a short summary (max 72 characters), followed by a blank line and a detailed description if necessary.
  3. Test your changes

    • Run all unit tests before committing.
    • Add or update xUnit tests as needed.
    • Use AwesomeAssertions for assertions and Moq for mocking in tests.
  4. Review your changes

    • Double-check for accidental debug code or commented-out code.
    • Ensure only relevant files are staged.

Thank you for helping maintain code quality!