English | Русский
IX-Ray project contributing guide
The process of contributing to the project is described in detail in this document
The first thing to do is to read and follow our Code of Conduct
There are two main types of contributions: submitting issues about problems and submitting pull requests. Each of these types of contributions is described in detail below
You can help us by submitting issues to repository. At the moment there are 2 main ways of submitting an issue in the project: bug reports and feature requests. All existing forms are provided with brief explanations
- Reports are suitable if you find a bug in some part of the project and want to create a report
- Also there is a possibility submit a feature request if it seems to you that the project lacks any feature
You can also help us by submitting pull requests. The process of submitting a pull request consists of several steps:
- Find what you want to implement or improve
- Make a fork
- Create a branch with name in the appropriate style
- Make and test the changes
- Create commits according to the accepted style
- Create and submit a pull request
- Wait for CI/CD pipelines and code review to pass
When a pull request is submitted, at least one project participant must conduct a code review, after which the changes are corrected (if it's necessary) and merged into the project