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

Misplaced word in 'Repository Terminology' under 'About repositories' #35912

Closed
1 task done
ashwingopalsamy opened this issue Jan 12, 2025 · 3 comments · Fixed by #35913
Closed
1 task done

Misplaced word in 'Repository Terminology' under 'About repositories' #35912

ashwingopalsamy opened this issue Jan 12, 2025 · 3 comments · Fixed by #35913
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories

Comments

@ashwingopalsamy
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories#repository-terminology

What part(s) of the article would you like to see updated?

What part(s) of the article would you like to see updated?

  • The definition of "Upstream" under the "Repository Terminology" section.

Give as much detail as you can to help us understand the change you want to see.

  • The current definition states: "Upstream: The branch on an original repository that has been forked or cloned. The corresponding branch on the cloned or forked branch is called the "downstream.""
  • The word "repository" should be used instead of "branch" in the later part of the definition.
    • "Upstream: The branch on an original repository that has been forked or cloned. The corresponding branch on the cloned or forked branch repository is called the "downstream.""

Why should the docs be changed? What use cases does it support?

  • The current definition is inaccurate and can mislead users, especially beginners, about the relationship between upstream and downstream repositories.
  • Correcting this definition will:
    • Improve the accuracy and clarity of the documentation.
    • Prevent confusion and misunderstandings for users learning about Git and GitHub.
    • Ensure that users have a solid foundation for understanding how forking and cloning work in a Git environment.

What is the expected outcome or behavior?

The definition of "Upstream" should be updated:

Upstream: The branch on an original repository that has been forked or cloned. The corresponding branch on the cloned or forked repository is called the "downstream."

  • This change will provide users with a correct and accurate understanding of the upstream and downstream relationships in Git.

Additional information

  • Reproducibility: This is a factual error in the documentation, so it's consistently reproducible.

  • User impact: The impact is potentially significant as incorrect terminology can:

    • Lead to confusion and misunderstanding among users, especially beginners.
    • Hinder effective collaboration and code management practices.
    • Create difficulties in understanding and troubleshooting issues related to forking and cloning.
  • Context: The incorrect definition appears within the "Repository Terminology" section of the GitHub documentation, likely within a page or section dedicated to explaining Git concepts and workflows.

Screenshot 2025-01-12 164354

@ashwingopalsamy ashwingopalsamy added the content This issue or pull request belongs to the Docs Content team label Jan 12, 2025
Copy link

welcome bot commented Jan 12, 2025

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 12, 2025
@nguyenalex836 nguyenalex836 added repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Jan 13, 2025
@nguyenalex836
Copy link
Contributor

@ashwingopalsamy Thank you for opening an issue and linking it to your PR! ✨

@ashwingopalsamy
Copy link
Contributor Author

Thanks, @nguyenalex836. Glad I could help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants