From 8135a52d8cfaed2963bcec4d19d6560a908866aa Mon Sep 17 00:00:00 2001 From: sBubshait Date: Wed, 29 May 2024 12:21:22 +0100 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f2da453 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Group Members +Group Number: 43 + +Group Members: +- [E] Ethan +- [G] George +- [S] Saleh +- [T] Themis + +# Conventions + +### Commit Messages +**This is assessed** so please follow the conventions: + +- Use imperative / simple present tense for commit messages. e.g., `Add fetch cycle`, `Fix ...`, `Update`, `Delete`, etc. *NOT*: `Added`, `Fixed`, etc. +- Keep the first line short (72 characters or less). If more is needed, add a blank line and then add more details. (Commits should be small enough so that this is not hard to do). +- If in any commit you worked with someone else on the same commit, e.g., live coding or pair programming, add their initial in the end in the format, `, w/ [Initial]`. E.g., `Add fetch cycle, w/ S`. + +# Contribution Guidelines + +General Guideliens: + - NEVER USE THE MASTER BRANCH FOR CONTRIBUTIONS. Always create a new branch for your contributions. Work only on a branch. + - Don't merge your branch with the master branch after you finish. Create a Pull Request (PR) instead. This then is to be reviewed by at least one other team member. + - Don't merge your PR yourself. Wait for the reviewer to merge it. You can tag the reviewer in the PR if you want. + +Flow: + 1. Clone the repo. + 2. Create a new branch. Name it something that makes sense. See below. + ```bash + git checkout -b fetch-cycle + ``` + + - If pair programming but each is working separately, augment the branch name with your initial. e.g., `fetch-cycle-s`. Otherwise, just name the branch something sensible, with all lowercase and hyphens for spaces. + + - You can ensure that you are in a branch by running `git branch`. + + 3. Make your changes. (Commit often) + 4. Push your branch to the remote. + 5. Once all is done, head to GitLab and create a new Pull Request. \ No newline at end of file