Skip to content

Add terms to the glossary #5014

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

Merged
merged 3 commits into from
Oct 14, 2021
Merged

Conversation

itsguneetsingh
Copy link
Contributor

Made certain changes to formula for Bayes theorem

@michaelosthege
Copy link
Member

The glossary is being edited in #4984 and #4987. Merging this PR would lead to quite some git conflicts.
So please either open a PR into those branches, or contribute edits/glossary terms with the "insert suggestion" feature on the diff.

@twiecki
Copy link
Member

twiecki commented Sep 23, 2021

Thanks @Guneetconvent2002, can you give more descriptive titles?

@itsguneetsingh
Copy link
Contributor Author

The glossary is being edited in #4984 and #4987. Merging this PR would lead to quite some git conflicts.
So please either open a PR into those branches, or contribute edits/glossary terms with the "insert suggestion" feature on the diff.

I don't really understand what you mean by the "insert suggestion" feature. About opening a PR in those branches, the 2 PRs have 2 different branches. Which one do you want me to use? or do you want me to put a PR for merging in their repos? I'm a little unclear here

@itsguneetsingh itsguneetsingh changed the title Extension to PR #4986 CU-5t5y0p Regarding issue #222 of pymc-devs/pymc-examples (Extension to PR #4986) Sep 23, 2021
@itsguneetsingh
Copy link
Contributor Author

Thanks @Guneetconvent2002, can you give more descriptive titles?
Sure, would this be fine?

@michaelosthege
Copy link
Member

@Guneetconvent2002 #4987 is probably the right one. I was referring to this feature: https://til.hashrocket.com/posts/szgdi4at59-github-insert-a-suggestion-

Also the CU-... code in the PR title is to associated with an issue tracker used by the docs team. @martinacantaro can you take over to coordinate here? I'm not in the picture what you're currently doing with the glossary.

@itsguneetsingh itsguneetsingh changed the title CU-5t5y0p Regarding issue #222 of pymc-devs/pymc-examples (Extension to PR #4986) Regarding issue #222 of pymc-devs/pymc-examples (Extension to PR #4986) Sep 23, 2021
@martinacantaro
Copy link
Contributor

Hi, I see the title changed to include "(Extension to PR #4986)", but it should say #4987.
Also, from your comment in PR #4987 I see that you will move forward by leaving suggestions on that PR, so I will close this one. Thank you.

@olgadk7
Copy link
Contributor

olgadk7 commented Oct 4, 2021

@michaelosthege, thank you for your guidance. I’m also newish to OS and a little unclear on the process. Originally, the glossary instructions were for each contributor to work out of their own branch, thus #4984, #4987, and #5014 were created (I assumed conflicts could be resolved by some rebasing). So what’s a principled way for several people to add to the same file simultaneously? If this PR (#5014) leads to conflict, then either #4984 or #4987 (whoever comes second?) would too - will it also be resolved by inserting suggestions? And how is #4987 “probably the right one” vs #4984.

@michaelosthege
Copy link
Member

@olgadk7
You'll get git conflicts whenever two people edit the same lines (or when a lot has changed and git can't align it).
Technically you can resolve them by rebasing, but it's a rather advanced git technique and could be quite a hurdle for new contributors (I learned it less than a year ago).
Also all these rebase-related force-pushes trigger the CI pipeline which in our case consumes quite a lot of energy.

If you're creating the document from scratch and everybody is working on all paragraphs maybe draft it in HackMD or Google Docs first?
You can add Co-authored-by to a commit message to track contributions. It's automatically appended when using the "insert suggestion" feature.

Otherwise the best way to keep PRs conflict-free is fast iteration and avoiding to edit the same file simultaneously with multiple people.

@OriolAbril OriolAbril reopened this Oct 14, 2021
@OriolAbril OriolAbril changed the title Regarding issue #222 of pymc-devs/pymc-examples (Extension to PR #4986) Add terms to the glossary Oct 14, 2021
@OriolAbril
Copy link
Member

@Guneetconvent2002 as the other PR was merged before incorporating your comments I have reopened this one and fixed the git conflicts in order to merge your contributions and give you proper attribution.

@OriolAbril OriolAbril merged commit 8027751 into pymc-devs:main Oct 14, 2021
@itsguneetsingh
Copy link
Contributor Author

Thank you @OriolAbril means a lot

olgadk7 added a commit to olgadk7/pymc3 that referenced this pull request Oct 15, 2021
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

Successfully merging this pull request may close these issues.

6 participants