-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Update contributing guide with etiquette section #5611
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
Conversation
|
Also, can we remove the guideline to prefix a draft PR with [WIP] (mentioned a couple of lines below your changes)? We should just use the draft tool from Github, it's more clean. |
This https://github.com/pymc-devs/pymc/blob/main/.github/workflows/arviz_compat.yml#L7 paths thing has never worked. |
|
Thanks @michaelosthege for creating this, the good news in all this is theres enough interested people that its actually a problem :) Of course one that still should be solved though, I appreciate you opening this PR. |
michaelosthege
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see we are not on the same page yet regarding the process.
Before we write up a really long list of rules and defintions that few people are going to read, shall we maybe discuss this in the next lab meeting instead?
ae77f7d to
009ffea
Compare
Codecov Report
@@ Coverage Diff @@
## main #5611 +/- ##
=======================================
Coverage 87.67% 87.67%
=======================================
Files 76 76
Lines 13717 13717
=======================================
Hits 12026 12026
Misses 1691 1691 |
|
I just prepended a commit that fixes the
Content-wise, I updated larger sections of the guide (it was really outdated!). If we don't come to an agreement regarding the "I want to work on this" stuff, I would propose to remove that last commit and merge just the CI fix and reformatting for now. |
the actual docs might have been kept a bit more to date, but I doubt that. Mid term this page will be gone and be converted to a link to the documentation: #5425 |
17c7be3 to
164ff54
Compare
|
I rephrased and reformatted the etiquette section again, based on @canyon289's suggestion: ...and also removing some things that were duplicated from the PR steps below. |
|
@michaelosthege wanted to say I really appreciate you putting this PR together. Even if I have quetsions about specifics I fully agree some additional guidance is needed on both sides, for contributors and for us so things are smoother. Thank you prompting this discussion |
38e51ed to
1c5a9bd
Compare
6e9baf3 to
c4fc278
Compare
Did you manage to do this? I don't see it in the changes |
Yes, it was the old line 95 https://github.com/pymc-devs/pymc/pull/5611/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L95 |
0eb1573 to
bd82971
Compare
|
After #5619 was just merged, I rebased this branch. Looks like the new workflow filters are doing their job. No tests were triggered by these Markdown-only changes :) EDIT: Just trailing whitespace again 🙄 |
Co-authored-by: Ravin Kumar <[email protected]> Co-authored-by: Oriol Abril <[email protected]>
bd82971 to
bbe8b98
Compare
|
|
||
| * All other tests pass when everything is rebuilt from scratch. See | ||
| [Developing in Docker](#Developing-in-Docker) for information on running the test suite locally. | ||
| * Please select "Create draft pull request" in the dropdown menu when opening your pull request to indicate a work in progress. This is to avoid duplicated work, to get early input on implementation details or API/functionality, or to seek collaborators. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Please select "Create draft pull request" in the dropdown menu when opening your pull request to indicate a work in progress. This is to avoid duplicated work, to get early input on implementation details or API/functionality, or to seek collaborators. | |
| * Please select "Create draft pull request" in the dropdown menu when opening your pull request to indicate a work in progress. This most importantly will add a claim to the issue ticket if there is one. It also will help avoid duplicated work, to get early input on implementation details or API/functionality, or to seek collaborators. | |
| * In the pull request form in Github paste the link to the issue ticket in the body so Github will link the two together |
canyon289
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved, i mostly reworded some things for clarity, and added a couple of extra points
Feel free to reject any of my edits and merge
Co-authored-by: Ravin Kumar <[email protected]>
Lately we have seen several examples where people asked for permission or commented that they wanted to work on an issue, but did not follow up with a pull request within several weeks or at all.
Because this is blocking other people from getting the work done, and thereby slowing the overall progress, I'm proposing to add a corresponding section to our
CONTRIBUTING.md.The gist of it is:
DraftPRs as soon as they start working on it.I think the risk of doing work twice is really low.
Also among high-frequency contributors pledges are rare - if happening at all they are usually more of the kind "I can do this after these two other things are merged".
And in the rare event of two people picking up the same issue at the same time (within 1-3 days) they can help out each other and decide which PR to go for.
Why are the tests triggering? I thought they only run if there are changes in
.pyfiles?(I cancelled them to save resources.)