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.

Sign up for GitHub

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

Jump to bottom

Git Bootcamp: similar content in two sections #888

Closed
hugovk opened this issue Jun 9, 2022 · 4 comments
Closed

Git Bootcamp: similar content in two sections #888

hugovk opened this issue Jun 9, 2022 · 4 comments
Assignees
@ezio-melotti
Labels
good first issue New contributors help wanted

Comments

@hugovk
Copy link
Member

hugovk commented Jun 9, 2022

Two nearby sections have very similar content.

https://devguide.python.org/gitbootcamp/ has a section on "Staging and Committing Files", then after sections on "Reverting Changes" and "Stashing Changes", there's another on "Committing Changes".

image

Do we need the "Committing Changes" section? It essentially duplicates info already in "Staging and Committing Files".
@ezio-melotti
Copy link
Member

I think we can remove it. I would also recommend git add -p, which IMHO is easier and less error-prone than a simple git add.

@Darnokiv Darnokiv mentioned this issue Jun 18, 2022
Merged
@Darnokiv
Copy link
Contributor

Darnokiv commented Jun 18, 2022 •
edited
Loading

Hello there,
I created a draft Pull Request #902 where I deleted the duplicated paragraph and added git add -p. Is this so ok?

I'm sorry if something is wrong, that is my first contribution.

@hugovk
Copy link
Member Author

hugovk commented Jun 18, 2022

Hi there! That looks good, thank you! You can mark it as ready for review :)

ezio-melotti added a commit that referenced this issue Jun 22, 2022
@Darnokiv @ezio-melotti
Deleted duplicated paragraph (#902)
2714ab8 
* Deleted duplicated paragraph

Deleted the duplicated paragraph "Committing Changes" (already in the paragraph "Staging and Committing Files") and changed "git add" to "git add -p". All accordingly to #888

* Corrected "git add -p"

Corrected a mistake with "git add -p" and added the normal "git add" command again

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@ezio-melotti ezio-melotti self-assigned this Jun 22, 2022
@ezio-melotti
Copy link
Member

The PR is now merged, thanks to @Darnokiv for working on it, @hugovk for the report, and @ambv for fixing the CLA issues!

kitarefake added a commit to kitarefake/devguide that referenced this issue Jul 15, 2024
@kitarefake @ezio-melotti
Deleted duplicated paragraph (#902)
1d2e22f 
* Deleted duplicated paragraph

Deleted the duplicated paragraph "Committing Changes" (already in the paragraph "Staging and Committing Files") and changed "git add" to "git add -p". All accordingly to python/devguide#888

* Corrected "git add -p"

Corrected a mistake with "git add -p" and added the normal "git add" command again

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ezio-melotti ezio-melotti

Labels
good first issue New contributors help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hugovk @ezio-melotti @Darnokiv