Contributing to a project on GitHub

image-20241105-113123.png
Don’t do this!

To propose modifications for a public repository, follow these steps:

  • Create an issue : Create an issue in the main repository describing the modifications

  • Fork the Repository: Create your own copy of the repository under your GitHub account by forking it. This lets you make changes without affecting the original project.

  • Clone the Forked Repository: Clone your fork to your local machine so you can make changes locally.

  • Make Changes: Implement the changes you want in the code. You can create a new branch in your forked repository to keep your changes separate from the main branch.

  • Commit and Push Changes: Once your changes are ready, commit them to your branch and push them back to your forked repository on GitHub.

  • Open a Pull Request: Go to the original repository and open a pull request (PR) from your forked repository. This notifies the repository maintainers about your proposed changes.

  • Discuss in the PR: The maintainers may review your PR and ask for modifications or approve it. Once approved, they can merge your changes

  • Merge PR: Once the changes approved, merge the PR into develop branch not main:
    Merge into develop for several issues, typically 3-7 per week, then, when ready to release, merge develop into main, typically every 2-4 weeks

To Make Any Changes After Merging

  • Create an issue to track the change needed.

    • Write a clear description of the issue

  • From within that issue, create a branch where you fix the issue.

  • After making the changes, open a new PR and only modify that branch to address PR comments