You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
20 lines
772 B
Markdown
20 lines
772 B
Markdown
3 years ago
|
# Contributing Guidelines
|
||
|
|
|
||
|
|
**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.**
|
||
|
|
|
||
|
|
### Issues
|
||
|
|
|
||
|
|
1. Provide product version where the problem was found;
|
||
|
|
2. Provide info about your environment;
|
||
|
|
3. Provide detailed info about your problem;
|
||
|
|
4. Provide steps to reproduce the problem;
|
||
|
|
5. Provide actual and expected results.
|
||
|
|
|
||
|
|
### Code
|
||
|
|
|
||
|
|
1. Check your code **before** creating pull request;
|
||
|
|
2. If tests are present in a project, add tests for your code;
|
||
|
|
3. Add inline documentation for your code;
|
||
|
|
4. Apply code style used throughout the project;
|
||
|
|
5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_).
|