Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 821 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 821 Bytes

How To Contribute

If you want to add a feature first open an issue so we can talk about it.
Other than that feel free to tackle one of the issues.

Branching Model

The project uses Driessen's branching model

How Does It Work

Basically, fork the project on github, clone, make a new branch:

git clone <url_to_your_fork>
cd among-stars
git checkout -b <branch_name> develop

After changing some files, you can test your changes and catch any errors by building the project.
Then commit and push:

# made some changes
make
git commit -m 'commit message'
git push origin <branch_name>

You can now open a pull request from <branch_name> to the develop branch. Thanks for your contribution! 🤟