Contributions guidelines

contribution-guidelines.md

When starting a new session

// update your local git repository
git remote update

// update your master branch
git checkout master
git pull

// create a new branch, from the updated master branch
git checkout -b new-branch

When resuming a session

# update your local git repository
git remote update

# update your master branch
git checkout master
git pull

# If there was changes on the master branch, rebase your branch
git rebase master

# If you push after rebasing changes from master, you need to force push your branch
git push --force

Pushing your branch to the remote repository

# The first time the branch is pushed
git push -u origin head

# The next times
git push

When your branch is ready for review

• In your web browser, go to the GitHub repository, and open a pull request from your branch
• Give a nice name to the Pull request, and mention issues in it eg: "Add stock destination for defective products, fixes #14"
• Assign someone as a reviewer

Addressing review comments

• Address the review comments in your local repository
• Push the changes to the branch
• Mark the comments as closed
• Re-request a review, from the pull request page

A few rules about pull requests

• The title and descriptions are important, and must mention the issues the pull request is addressing
• The person responsible for the pull request is responsible for closing the pull request review comments
• If the person responsible for the pull request does not agree with a comment, he still has to answer to it and give a reason
• The branch of the pull request must be based on master and pass eventual CI/CD checks, to be eligible for merge
• The work is not done until a pull request is merged
• Review your own code before you request a review from someone else (I personnaly always review my code from the pull request "Files changed" tab before submitting it)