Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

40 lines (35 loc) · 1.25 KB

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 main branch.

    a) The pull request name format should correspond to format

    [#<issue reference>] <pull request name>
    

    Example

    [#86] add community standards
    

    b) The pull request branch should contains tag (bugfix, feature, etc.) and correspond to format

    <tag>/<issue reference>_<additional description if required>
    

    Example

    feature/86_community_standards
    

    c) The commit message should correspond to format

    [#<issue reference>] <commit message>
    

    Example

    [#86] add community standards
    
  • 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.