Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 2.75 KB
Raw

Contributing

Thank you for taking the time to contribute! All types of contributions are welcome!

When contributing to this project, please first discuss the change you wish to make via Discussions or Issues with the project owners. In addition, please follow code of conduct in all your interactions with the project.

If you don't have time to contribute, you may want to consider the following easy ways to support the project:

  • Star the project.
  • Refer this project in your project's files.
  • Write about the project on social media.
  • Tell your friends about the project.

Pull Requests

We actively welcome your pull requests. Follow these steps:

  1. Fork the repository and create your branch from main.
  2. Create draft Pull Request.
  3. Make code changes.
  4. Create new tests if necessary and ensure all test passes locally.
  5. Update documentation if necessary.
  6. Increase the project version numbers.
  7. Mark your Pull Request ready for review.

Discussions

If you don't understand something and need clarification, you can always ask us via Discussions or Issues. Before you ask a question, it is best to read available documantation and search for existing Discussions and Issues that might help you.

If you are going to ask a question or bring attention to a problem, we recommend the following:

  • Open a Discission or an Issue.
  • Provide as much relevant information as you can about your problem.
  • Provide OS type and project version.

We will take care of your questions as soon as possible.

Issues

We use Issues to track public bugs and errors. Before you make an Issue, make sure your description of the problem is clear and provides sufficient instructions to reproduce the problem. Then follow these steps:

  1. Open an Issue.
  2. Explain the behavior you would expect and the actual behavior.
  3. Provide as much relevant information as possible.
  4. Provide sufficient instructions to reproduce the problem.
  5. Provide OS type and project version.

Code Style

This project enforce a specific source code style. The style is described in stylecomp.json, .ruleset and .editorconfig. Without meeting these requirements, it will not be possible to build the project.

License

By contributing to the project, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.