Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 2.99 KB
Raw

Contributing to Stateless

If you're reading this page, thank you for considering making a contribution to Stateless! This project depends on the work of the community. As maintainers, we'll try our best to make bug fixes, review PRs, and respond to issues and feature requests.

Getting Started

If you've found a bug, need a new feature or want to suggest a change, be sure to take a look through the issues and pull requests in case it's been discussed before or is already in progress.

If you've found a security vulnerability, please report it using the Security Advisories page.

For anyone new to contributing to open source, there are some great guides to help you get started, such as this one by freeCodeCamp.org and this one from Open Source Guides.

General Guidance

It's best to start by discussing a proposed change in an issue, be it a new issue you've created or an existing issue you're willing to help with. Let others know you're working on it.

Check that your fork is synced with the upsream repo before you start working on a change, then create a branch from it and commit your changes to that branch. When you're ready for the change to be reviewed, create a pull request to merge your change back to the upstream dotnet-state-machine:dev branch.

Please make sure your change meets the following criteria before raising a pull request:

  • Keep the change relevant to the specific issue being addressed; making changes that haven't been discussed could have unintended side effects.
  • Add unit test coverage for your work; this not only helps to validate that your change works as described, it also acts as documentation and helps to defend against future regressions.
  • Update the documentation! Help others benefit from your work by including guidance in the README.
  • Be open and encouraging to constructive feedback; reviewers may ask for further changes or may want to discuss alternative approaches; the project will benefit from your patience and your willingness to engage with reviewers.

Other Ways to Contribute

  • Participate in open discussions, for instance by helping to answer questions or offering guidance to others.
  • Improve the documentation, even something as small as fixing a typo or including a code snippet in the README; it all helps.
  • Review a pull request; take a look through the open pull requests and offer constructive feedback.
  • Boost the project; star the repository, mention it on social media, or link to it in your project's README.