Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 2.1 KB
Raw

Contributing

Feature requests and bugs

Please submit any feature requests or bugs as an issue in GitHub.

Pull requests

The easier your PRs are to review and merge, the more likely your contribution will be accepted.

If you wish to contribute code, please consider the guidelines below:

  1. Create an issue detailing the motivation for the change.
  2. Fork the repository to your GitHub account.
  3. Create a branch to work on your changes.
  4. Try to commit changes in a logical manner. Messy histories will be squashed if merged.
  5. Please follow the existing code style and EditorConfig formatting settings so that your file touches are consistent with ours and the diff is reduced.
  6. If fixing a bug or adding new functionality, add any tests you deem appropriate.
  7. Test coverage should not go down.
  8. Note any breaking changes in your PR description.
  9. Ensure build.ps1 runs with no errors or warnings and all the tests pass.
  10. Open a pull request against the main branch, referencing your issue, if appropriate.

Once your pull request is opened, the project maintainers will assess it for validity and an appropriate level of quality. For example, the Pull Request status checks should all be green.

If the project maintainers are satisfied that your contribution is appropriate it will be merged into the main branch when appropriate and it will then be released when the library is next published to NuGet.

Releases

  • Check the version number has been updated since the last release - follow SemVer rules
    • Bump the version in version.props if neccessary.
  • Update the CHANGELOG.md
  • Create a new release in GitHub with appropriate release notes and tagged version number (for example v1.2.3).
  • A build will run for the tag in GitHub Actions and publish the package to NuGet.
  • Wait for NuGet.org to index the package.
  • Share the news! 🎉