Development Procedures

[sync-by-unito[bot]]

To work on our repository, we want to ensure that we have a structured workflow where we don't overwrite people's changes on accident or cause trouble with the main branch of the GitHub repository.

To do this, we are going to be using forks of GitHub repositories and pull requests. Here's a step-by-step guide on how to set up a structured workflow to prevent accidental overwrites and troubles with the main branch using forks and pull requests:

‌

1. Fork the Main Repository
   1. Go to the main repository.
   2. Click the "Fork" button in the upper right corner. This will create a copy of the repository under your GitHub account.
2. Clone your fork
   1. Go to your forked repository on GitHub.
   2. Click the "Code" button and copy the repository URL.
   3. Open your terminal and use the git clone command to clone your fork to your local machine.
3. Create a New Branch
   1. Before making any changes, create a new branch for your work. This keeps your changes isolated from the main branch
4. Make Changes on the Branch
5. Push Changes to your fork on GitHub
6. Create a Pull Request
   1. Go to your forked repository on GitHub.
   2. Click on the "Pull Requests" tab.
   3. Click the "New Pull Request" button.
   4. Select the base repository (the main repository) and the base branch (typically "main" or "master").
   5. Select your forked repository and branch in the "compare" section.
   6. Write a clear and concise description of your changes.
   7. Click "Create Pull Request."
7. Review and Collaborate
   1. Others will review pull request and may request changes or approve it.
   2. You can continue to make changes to your branch, and they will automatically be added to the pull request.
8. Merge Pull Requests
   1. Once your pull request is approved, it can be merged into the main branch of the main repository.
9. Keep Your Fork Updated:
   1. Periodically, it's a good practice to fetch and merge changes from the main repository into your fork to keep it up to date.

‌

This workflow ensures that changes are proposed and reviewed before merging into the main branch, reducing the risk of accidental overwrites and conflicts. It also allows for collaborative development while keeping the main branch stable.

┆Issue is synchronized with this Trello card by Unito

[sync-by-unito[bot]]

➤ Tomas Premoli commented:

The right permissions for the GitHub repo have to be set up to do this. I have contacted Achim and am trying to get everything set up

[sync-by-unito[bot]]

➤ Tomas Premoli commented:

https://unity.github.com/ ( https://unity.github.com/ )