Development guide

Issues

Please check the GitHub Issues to find things that need to be worked on. If anything isn't clear or you need more info, please leave a comment.

If you think of more changes or features you'd like to see, please add them!

Contributing

Once you have identified an issue in the project and want to contribute a change, please follow these steps:

• Switch to the develop branch and pull the latest changes

  git switch develop
  git pull
  

• Create a new branch for your changes

  git switch -c <new_branch_name>
  

• Upload the branch to GitHub and create a draft pull request

  git push -u origin <branch_name>
  

• Begin working in the new branch

  Please commit changes and push to GitHub frequently in order to keep everyone up to date and to track progress.

• Once complete, mark your pull request as Ready for review

  Some modifications to your code may be requested, and you can view those on the pull request page.
  Finally, once all changes have been approved, they will be merged into develop!

Note: you are always free to create multiple branches and work on several issues at the same time; however, be aware that merge conflicts may occur if you change the same file in separate branches.

Naming Conventions

In order to facilitate a clear development history, please keep commit messages and branch names concise yet informative. You can find information on helpful naming conventions here.