Skip to content

Commit

Permalink
[#61] add contributing info
Browse files Browse the repository at this point in the history
  • Loading branch information
kozmod committed Jan 16, 2024
1 parent 3e53375 commit 961dd4a
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributing

### With issues:

+ Use the search tool before opening a new issue.
+ Please provide source code and commit sha (optional) if you found a bug.
+ Review existing issues and provide feedback or react to them.

### With pull requests:

+ Open your pull request against `dev` branch.

a) The pull request name format should correspond to format
```
[#<issue reference>] <pull request name>
```
Example
```
[#61] add `CONTRIBUTING.md`
```
b) The pull request branch should contains tag (`bugfix`, `feature`, etc.) and correspond to format
```
<tag>/<issue reference>_<additional description if required>
```
Example
```
feature/61_contributing_info
```
c) The commit message should correspond to format
```
[#<issue reference>] <commit message>
```
Example
```
[#61] add contributing info
```
+ Pull request should have no more than **one** commits, if not you should squash them.
+ It should pass all tests in the available continuous integration systems such as GitHub Actions.
+ Pull request should contain tests (added/modified) to cover your proposed code changes.
+ If pull request contains a new feature, all information about feature must be described in `README.md`.

0 comments on commit 961dd4a

Please sign in to comment.