Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 2.2 KB

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

Submitting a pull request

  1. Fork and clone the repository.
  2. Configure and install the dependencies: dotnet restore.
  3. Make sure the tests pass on your machine: dotnet test.
  4. Create a new branch: git checkout -b my-branch-name.
  5. Make your change, add tests, and make sure the tests still pass.
  6. Push to your fork and submit a pull request.
    • when submitting your pull request, please do so against the develop branch unless explicitly asked otherwise
  7. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide which is using standard.
  • Write and update tests.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Document your changes in code and the readme, if applicable
  • Write a good commit message
    • keep the subject line under 72 characters
    • make the subject descriptive (prefer Refactor Foo to remove Bar to change foo)
    • use the imperative mood (prefer Fix foobar to Fixed foobar)

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.

Resources