collaborating.md

Steps on Collaborating

1. Cloning the development branch

To clone the repo and start working, use the following commands.

SSH:

git clone -b development [email protected]:ArshavineRoy/doros-wedding-client.git

HTTPS:

git clone https://github.com/ArshavineRoy/doros-wedding-client

2. Pick an item from the Trello workspace's Todo board and move it to Doing

Steps on how to do this will be demonstrated on call.

3. Create a branch in development

Create a branch for what you are working on. Start branches with an ft- prefix. e.g., ft-login.

git branch <ft-name>

4. Switch to your branch

git checkout <your branch>

NOTE: Always confirm the branch you're on at the bottom left corner of your VS Code editor before you start coding.

Steps on how to easily create and switch to a branch in VS Code will be demonstrated on call.

5. Installing packages and running the client

npm start

6. Work on your feature and make sure it works perfectly

This will reduce the time taken during code review and also minimize conflicts.

7. Commit your work

Please make sure to write meaningful commit messages. Describe what you have done.

Messages like "Done" are not welcome.

git add .

git commit -m "<your message>"

8. Push your work to YOUR BRANCH

If it's the first time you're pushing to this branch, make sure to set upstream with -u so you can always use git push anytime.

git push -u origin <your branch>

For subsequent pushes to the same branch

git push

9. Go to GitHub and make a Pull Request to DEVELOPMENT

Steps on how to do this will be demonstrated on call.

10. Whenever possible, move your task in Trello from Doing to Code Review

Steps on how to do this will be demonstrated on call.

11. Pulling changes in development branch on GitHub to your local development branch

If there are changes in development on GitHub [merged changes will be announced] and you want to have them, switch to development branch in VS Code and run the following command.

NB: Ensure you have committed or pushed all changes in your branch first before pulling changes in development!

git pull

12. Resolve conflicts in development branch, if any

Steps on how to do this will be demonstrated on call.

13. Switch back to your branch or create a new one if need be

Steps on how to do this will be demonstrated on call.

14. Merge pulled changes in development to your branch

git merge origin/development

15. Resolve conflicts in your branch, if any, by "accept all current" or "accept all incoming" changes

Incoming changes are those pulled from GitHub, and current means what you had before starting the merge process. Accept incoming if the new changes are what you want in your code, keep current if you don't want to change your code.

Conflicts are resolved one by one, carefully.

If you have any issues, schedule a call with me.

Happy coding!