Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 2.49 KB
Raw

Contributing to Raiqub Expressions

We take Pull Requests!

Before you send Pull Request

  1. Contact the contributors via the Github Issue to make sure that this is issue or bug should be handled with proposed way. Send details of your case and explain the details of the proposed solution.
  2. Once you get approval from one of the maintainers, you can start to work on your code change.
  3. After your changes are ready, make sure that you covered your case with automated tests and verify that you have limited the number of breaking changes to a bare minimum.
  4. We also highly appreciate any relevant updates to the documentation.
  5. Make sure that your code is compiling and all automated tests are passing.

After you have sent Pull Request

  1. Make sure that you applied or answered all the feedback from the maintainers.
  2. Pull request will be merged when you get approvals from at least 1 of the maintainers (and no rejection from others).

Working with the Git

  1. Fork the repository.
  2. Create a feature branch from the main branch.
  3. We're not squashing the changes and using rebase strategy for our branches (see more in Git documentation). Having that, we highly recommend using clear commit messages. Commits should also represent the unit of change.
  4. The commits must follow the Conventional Commits specification.
  5. Before sending PR to make sure that you rebased the latest main branch from the Raiqub Expressions repository.
  6. When you're ready to create the Pull Request on GitHub.

Code style

Coding rules are set up in the .editorconfig file. This file is supported by all popular IDE (eg. Microsoft Visual Studio, Rider, Visual Studio Code) so if you didn't disabled it manually they should be automatically applied after opening the solution. We also recommend turning automatic formatting on saving to have all the rules applied.

Licensing and legal rights

By contributing to Raiqub Expressions:

  1. You assert that contribution is your original work.
  2. You assert that you have the right to assign the copyright for the work.
  3. You are accepting the License.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.