You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current contributing.md file lacks clarity regarding branch naming conventions, specifically in commands where a new branch is created and pushed. This ambiguity may lead to confusion among contributors, particularly those who are new to the project or open source development in general.
To improve the contribution process and ensure consistency, it's essential to clarify which branch names should be used for local branches and which should be used for the forked repository. Providing clear instructions will help streamline the contribution workflow and reduce potential errors.
Proposed Changes:
Specify in the contributing.md file that <local_branch_name> refers to the branch created on the contributor's local repository for their own use.
Clarify that <original_branch_name> (unchanged) refers to the branch on the contributor's forked repository, corresponding to the branch they intend to contribute changes to.
By addressing this issue, we aim to enhance the overall contributor experience and facilitate smoother collaboration within the project.
Add ScreenShots
When creating a new branch on your local repository, use a descriptive name that reflects the purpose of your changes. For example:
git checkout -b feature/scrape-avatar
This creates a new branch named "feature/scrape-avatar" on your local repository, where you can implement changes related to scraping user avatars.
When pushing changes to your forked repository, ensure that the branch name matches the one you created locally. For example:
git push origin feature/scrape-avatar
This command pushes the changes from the "feature/scrape-avatar" branch on your local repository to the same-named branch on your forked repository.
Record
I agree to follow this project's Code of Conduct
I'm a GSSoC'24 contributor
I want to work on this issue
The text was updated successfully, but these errors were encountered:
Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.
What's wrong with the existing documentation
The current contributing.md file lacks clarity regarding branch naming conventions, specifically in commands where a new branch is created and pushed. This ambiguity may lead to confusion among contributors, particularly those who are new to the project or open source development in general.
To improve the contribution process and ensure consistency, it's essential to clarify which branch names should be used for local branches and which should be used for the forked repository. Providing clear instructions will help streamline the contribution workflow and reduce potential errors.
Proposed Changes:
Specify in the contributing.md file that <local_branch_name> refers to the branch created on the contributor's local repository for their own use.
Clarify that <original_branch_name> (unchanged) refers to the branch on the contributor's forked repository, corresponding to the branch they intend to contribute changes to.
By addressing this issue, we aim to enhance the overall contributor experience and facilitate smoother collaboration within the project.
Add ScreenShots
When creating a new branch on your local repository, use a descriptive name that reflects the purpose of your changes. For example:
git checkout -b feature/scrape-avatar
This creates a new branch named "feature/scrape-avatar" on your local repository, where you can implement changes related to scraping user avatars.
When pushing changes to your forked repository, ensure that the branch name matches the one you created locally. For example:
git push origin feature/scrape-avatar
This command pushes the changes from the "feature/scrape-avatar" branch on your local repository to the same-named branch on your forked repository.
Record
The text was updated successfully, but these errors were encountered: