Contributing

Here you can see the info about how to contribute to the project.

First things to do

Follow Cloning and installation and Running pages' contents. If you have done it already, go to the issues on GitHub and pick one you would like to work on. If you have an original idea, make a new issue and it will appear on the Roadmap board.

Find tasks to do

You can either do something from the Issues and Bugfixes table or try to implement some new features from Roadmap project board. Also, if you want to implement a new feature NOR fix a non-existent bug, you should create a new issue and describe your problem. Add it to the board you need and follow next steps!

Branching

Add a new branch by running the following command:

git branch fix-39 # Here you have to pick a name. Here, for example, it is 'fix-39'

Switch to the newly created branch:

git checkout fix-39

Committing

When you are done, commit the code:

git add .
git commit -m "Fixes #39"

Commit command will automatically lint the code for you. Then you have to just push the code to the repo:

git push --set-upstream origin fix-39

Pull-requesting

Here you can just sit and relax - it needs some time to review all the beautiful changes you have made! When the process is done, your pull request will be merged to the master branch and fix-39 branch will be deleted.

Thank you in advance for contributing to the project!

Last updated