Issues
A full guide on how issues are handled in github can be found at the following link.
The bootcamp progression is guided by issues. They determine the objectives we need to achieve for each days.
Day issues are reported in the project panel (they act as meta issues). Only this issues are reported in this panel in order to have a global overview of the project.
Exercises issues are associated with each days using a to-do list as shown below. The link the exercise issue is next to the corresponding item in the to do list. When closing an exercise issue, the box corresponding to the exercise must be ticked manually.
This allows us to see a progression bar associated with each day when an exercise issue is closed.
- On GitHub, navigate to the main page of the repository.
- Under your repository name, click Issues.
- Click New issue.
After creating an issue a number is associated with the issue (here "2"), this number will be used when closing the issue.
When creating an issue, a label can be associated with a label. The three labels currently used are :
- PhaseXX (where XX is the number of the phase)
- documentation
- bug
You can assign yourself to an exercise issue, but check first if a person is already assigned to it.
An issue can be closed in the issue panel but we prefer using commits with a specific syntax for that.
The following words assiociated with an issue will close the issue :
- close
- closes
- closed
- fix
- fixes
- fixed
- resolve
- resolves
- resolved
Here, there is an example :
git commit -m "fix : close #2"
When closing an exercise issue, the box corresponding to the exercise must be ticked manually.