Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 2.23 KB

Contributing

Contributions are welcome and will be fully credited. There are various ways to contribute:

  • Report bugs or request new features/improvements via the Issues page.
  • Start a discussion around new ideas or suggestions on the Discussions page.
  • Contribute code via Pull Requests on Github.

Issues

Before submitting a new issue, please check the issues and pull requests to avoid duplicates.

Discussions

If you have an idea or suggestion, feel free to start a discussion on the Discussions page. This is a great way to get feedback and discuss new ideas before submitting a pull request.

Pull Requests

If you would like to contribute via pull requests, a good way to get started is to filter the issues list by the good first issues label. This label is used for issues that are easy to fix and a good starting point for new contributors.

good first issues open

When submitting a pull request, please make sure to follow these guidelines:

1. Include feature or unittests

Your PR should include unittests where possible to cover the changes you made. This project uses the NUnit framework. If you're not sure how to write tests, please ask. To run the tests locally, you can use the following command:

$ dotnet test

2. Keep it simple

If your PR is too big, it will be hard to review. Try to keep it simple and small. If you want to do more than one thing, send multiple pull requests.

3. Keep it clean

Please remove any unrelated changes from your PR. If you have changes in your branch that are not related to the PR, please create a new branch for them.

If you have any questions, feel free to reach out to the maintainer(s). Thank you in advance for your contributions! 🎉