Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Branch Naming Conventions in Contributing.md #972

Closed
3 tasks done
Vaishnavigupta1312 opened this issue May 15, 2024 · 2 comments
Closed
3 tasks done

Clarify Branch Naming Conventions in Contributing.md #972

Vaishnavigupta1312 opened this issue May 15, 2024 · 2 comments

Comments

@Vaishnavigupta1312
Copy link

Vaishnavigupta1312 commented May 15, 2024

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

Scrape-up-branch_name

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
Copy link

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.

@Vaishnavigupta1312
Copy link
Author

@nikhil25803 Please assign it to me. and also tag the issue with 'GSSOC'24' and 'Level' labels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants