Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 1.87 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Installing Stoix for development

To develop features for Stoix, clone the repository and install the core and development dependencies as follows:

git clone https://github.com/EdanToledo/Stoix.git
cd Stoix
pip install -e .[dev]

Installing Pre-Commit Hooks

Install the pre-commit hooks:

pre-commit install
pre-commit install -t commit-msg

You can run all the pre-commit hooks on all files as follows:

pre-commit run --all-files

Naming Conventions

Branch Names

We name our feature and bugfix branches as follows - feature/[BRANCH-NAME], bugfix/[BRANCH-NAME] or maintenance/[BRANCH-NAME]. Please ensure [BRANCH-NAME] is hyphen delimited.

Commit Messages

We follow the conventional commits standard.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.