conda-forge.github.io icon indicating copy to clipboard operation
conda-forge.github.io copied to clipboard

Improved the grammar and added more lines.

Open Uma-95 opened this issue 2 years ago • 7 comments

I added some basic writing guidelines on how to contribute to the docs. @kathatherine @beckermr looking forward to feedback.

Uma-95 avatar Apr 08 '22 13:04 Uma-95

Hey, @Uma-95, just so you know, you didn't need to close your original PR. We usually keep one PR for each set of changes, even if there are mistakes and new changes need to be pushed. I'd recommend reading this documentation on PR reviews here, if you're unsure about how that works. Thanks!

kathatherine avatar Apr 11 '22 20:04 kathatherine

Hi @kathatherine, thanks for letting me know about the re-request review for a PR.'ve made changes and re-requested the review for the PR again.Kindly review.

Uma-95 avatar Apr 11 '22 21:04 Uma-95

@Uma-95 I'm just making sure, did you mean to add the glossary changes to this PR?

kathatherine avatar Apr 12 '22 22:04 kathatherine

Hey @kathatherine, this is my first time contributing to open source. I actually made changes(added a period in line for this )PR and committed those changes. Also, I opened issue #1705. I made some changes in the glossary for the same. But somehow I guess I messed up while I re-requested you to review this PR those changes got reflected here too. I'm confused. Could you please help me with this?

Uma-95 avatar Apr 13 '22 11:04 Uma-95

All I wanted to do was improve the glossary and link it to the introduction page in #1705 and adding the writing guidelines in #1696

Uma-95 avatar Apr 13 '22 11:04 Uma-95

Did you make a separate branch for each issue? It looks like these changes are coming from your main branch in your fork. Here's some documentation on repository branches: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches

Best practice is to make a branch for each issue you are making changes for. I like to name them with the number of the issue and a bit of a descriptive title. For instance, you could have a branch for issue 1696-writing-guidelines and one for 1705 called 1705-glossary-additions. It helps keep everything organized, especially if you have to come back to something after a few months and you don't remember anything about it, and it helps to keep your changes for each issue in their own separate baskets.

You may need to revert your changes (https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reverting-a-commit). Make sure you save your files somewhere else on your computer so you don't lose your work! Then, make a branch, put the changes in that are for that issue, and make a new PR.

I'm sorry I didn't notice this sooner!

kathatherine avatar Apr 13 '22 19:04 kathatherine

hey @kathatherine This is the change that I have made for #1696 . https://github.com/conda-forge/conda-forge.github.io/pull/1723 Kindly review.

Uma-95 avatar Apr 17 '22 11:04 Uma-95

Looks like this was superseded by https://github.com/conda-forge/conda-forge.github.io/pull/1723

jaimergp avatar Jun 22 '23 13:06 jaimergp