Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.27 KB

contributing.md

File metadata and controls

31 lines (21 loc) · 1.27 KB
Raw

Contributing

Workflow

Repository

The project uses the Forking Workflow with Pull Requests.

In short:

  1. Fork the upstream repository and clone it to your local machine.
  2. Follow the installation instructions.
  3. Create a branch for the feature you want to work on.
  4. When finished, push the feature branch to your repository.
  5. Create a pull request on the upstream repo and describe the changes you've made.
  6. Participate in discussion between the team members on whether the feature needs improvements or should be merged.
  7. Repeat!

For a more detailed guide on how to stay in sync with the upstream and avoid conflicts, read this.

Development

English should be used for variable names, docstrings, documentation etc for uniformity.

Basic house rules:

  1. PEP 8 compliance.
  2. Docstrings everywhere :)
  3. Comply to the project's .editorconfig (download the plugin here).

Contribute what?

Check the running projects to find things to work on.