The documents file is used to give the guidance for the documentation and git usage
Guide to markdown in md format
The "correct order" to push the code is:
git commit
git pull
git push
git status
To clone a repo
- On GitHub, navigate to the main page of the repository.
- Under your repository name, click Clone or download.
- In the Clone with HTTPs section, click to copy the clone URL for the repository.
- Open Terminal.
- Navigate the working directory to the location where you want the cloned directory to be made.
- Type
git clone, and then paste the URL you copied in Step 2.
To setup the correct upstream
- Open Terminal
- List the current configured remote repository.
git remote -v - Specify a new remote upstream repository that will be synced with the fork.
git remote add upstream <URL> - Verify the new upstream
git remote -v
It is recommend to update whenever a new file is created in the repo. We have to add the file into the tracking system
git add <filenames>
or add all files by
git add .
To commit the changes that you make(making a save of your work)
git commit -m "Message provide information about the changes"
or (recommended)
git commit -am "Message provide information about the changes"
To push the changes to github
git push origin <name of the branch>
Ex:
git push origin master
The project is managed use the kanban board for project management. Access the board using the "Board Tab" in the github.
The task is assigned by using tag. If you see the name, it is assigned to you. There is 3 columns:
- TODO is for the task need to do
- In Progress for work is working on
- Done is used for the work has been completed and ready to check.
Only put the issues to the "Closed column" if there is the closing statement in the issue. A developer confirmed that the implementation has been completed The UI allows user to arrange the issues by drag and drop to proper column