-
Notifications
You must be signed in to change notification settings - Fork 4
Code Management
If you are a new member to the project, this page should help you understand how we're managing our code for the project. Please see below for a more in depth description of how each of the code branches will work.
- Identify an issue you want to work on, and assign yourself to it.
- Either create a branch in this repository, or create a fork of the project for yourself. Make sure you branch or fork from the main branch.
- Complete the setup process if this is your first time using this project.
- Do your work. Commit and push your code to your branch or fork.
- Make a pull request back into this repository, but to the develop branch. It will be your responsibility to handle any conflicts if there are any. If you need help with this, make sure to ask!
- If your code passes tests, it will be merged to the main branch. That's it!
The main branch is the main stable version of the project. Code here will be merged from the develop branch once it has been tested and all functionality has been confirmed. When creating a new branch to do work, it is probably the safest option to create your branch from main. Nobody will be able to directly push code into main.
The develop branch is going to be the branch that you will request to have your code added into.
Create a feature branch off of main. Here you will be able to do your work. Once your work is completed, you will be able to push to this branch and create a pull-request to develop to have your code added to the repository.