跳到主要内容

Fork Workflow

The Fork workflow is a method for collaborating and contributing code, particularly suitable for open-source projects and team collaboration. It allows developers to fork another developer's project into their own account, make changes on the forked copy, and then contribute those changes back to the original project via Pull Requests.

Through the Fork workflow, developers can:

  • Fork (copy) a GitCode project to their account
  • Make changes in their copy, freely modify, add new features, or fix bugs
  • Submit changes back to the original project by creating Pull Requests so that project administrators can review and merge them into the original project.
  • This process is very common in open-source communities, allowing a large number of developers to participate in the project, driving its continuous development and improvement.

1. Fork the Project​

If you plan to contribute code to the project, you first need to fork it:

  • Click the "Fork" button at the top right to copy the project to your account.

    image-20241227144442842

    image-20241227145333508

2. Create a Feature Branch​

To facilitate development, it is recommended to create a feature branch within the forked project:

  • You can directly create a new branch from the fork project page.

    image-20241227150101792

  • Alternatively, you can switch to your project directory in the command line and use the following command to create and switch to a new branch:

    git checkout -b feature/your-feature-name

3. Commit Code Changes​

After developing on the feature branch, you can submit the changes:

  1. Commit the changes to your local repository:

    git add .
    git commit -m "Describe your changes"

  2. Push the changes to your fork:

    git push origin feature/your-feature-name

4. Create a Pull Request (PR)​

When your changes are ready to be merged into the main project, you can create a Pull Request:

  1. Go to the original project's page and click "New Pull Request".

image-20241227151651228 2. Select your feature branch to compare with the main branch of the project.

image-20241227151829927 3. Fill out the title and description of the PR, detailing the changes you made and their purpose.

image-20241227152048112 4. Click "Create" to submit the PR.

5. Participate in Code Review​

After submitting the PR, the project maintainers and other contributors may review your changes:

  • Feedback and Modifications:
    • Pay attention to the reviewers' feedback; they might request further modifications or additional information.
    • After making the necessary modifications based on the feedback, submit the new changes to update the PR.

6. Merge the PR​

If everything goes well, the project maintainers will merge your PR into the main project after reviewing it. Once the PR is merged, you will become a contributor to the project, and your changes will become part of the project.