Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 2.52 KB

Contributing

🎉 Firstly a huge thank you for taking the time to contribute.🎉

The following is a set of guidelines for contributing to these libraries. These are just guidelines, not rules, so feel free to use your own judgement, and to propose changes to these guidelines in a pull request.

Issues

Issues will be marked stale after 14 days of inactivity, and closed 14 days after they have been marked stale.

If an issue has been closed and you still feel it's relevant, feel a maintainer or and a comment to the closed issue.

Pull requests

Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools.

When creating a pull request please create an issue first, unless it's a simple change like a spelling correction.

  • Setup your build environment
    • Fork the repo.
    • Build your fork.
    • Branch your fork.
  • Making your code changes
    • Create an issue for the changes you want to make.
    • Add or change the code you want to add or change. Please add tests for the code you are adding or changing.
    • Build your code at the command line with dotnet build, this ensures all the code and documentation analyzers run.
    • Test
    • Commit your changes to your branch, with a meaningful commit message.
    • Rebase
    • Test
    • Push your commits to your fork.
    • Open a pull request.
    • Act on any comments in the pull request or associated issue.
    • Finally, hopefully, your pull request is merged into the main branch.

Dependencies Upgrades

Dependencies in the libraries should only be altered by maintainers. For security reasons, we will not accept PRs that alter our Directory.Build.props or nuget.config files. If you feel dependencies need upgrading please file an issue.