Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.41 KB
Raw
title
Contributing

Contributing to raspberry-py-iot

If you would like to become an active contributor to this project, please submit an issue with the contributor template.

Branching Strategy

In this strategy, there is only a single branch or "source of truth" - the master branch. The idea behind this strategy is to minimize the amount of human interaction required to maintain branches and to minimize the overrall number of maintained branches in general.

  • When developing a new feature or resolving a bug, checkout to a features/* or bugs/* branch using your approved GitHub issue number. For example, features/git-issue-6.

  • When you are finished developing, you'll push your code and create a pull request to the master branch.

  • Once the branch is approved and merged the branch will be deleted.

Local Development Commands

  1. Clone the repository or pull the latest changes from master.

    git clone git@github.com:dgonzo27/raspberry-py-iot.git && cd raspberry-py-iot

git pull origin master

  2. Install and enable pre-commit.

    pre-commit install

  3. Checkout to a features/* or bugs/* branch.

    git checkout -b features/git-issue-27

Code of Conduct

Before contributing to this repository, please review the code of conduct.