-
Notifications
You must be signed in to change notification settings - Fork 200
docs: Reorganize the "Development" section #1857
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
base: main
Are you sure you want to change the base?
Conversation
| ^^^^^^^^^^^ | ||
|
|
||
| Community consensus is key in the integration process. Expect a minimum | ||
| of 1 to 3 reviews depending on the size of the change before we consider |
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.
this is actually unclear to me: isn't it this instead, since there is a mention of community?
| of 1 to 3 reviews depending on the size of the change before we consider | |
| of 1 to 3 reviewers depending on the size of the change before we consider |
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 would rather have something like "Expect a minimum of 1 to 3 reviews from maintainers..."
| **Before submitting your pull request, ensure that your modifications haven't | ||
| introduced any new Sphinx warnings by building the documentation locally | ||
| and addressing any issues.** |
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.
Given the number of warnings already present, I think it's very hard check to do and to enforce.
Shouldn't it be removed?
| **Before submitting your pull request, ensure that your modifications haven't | |
| introduced any new Sphinx warnings by building the documentation locally | |
| and addressing any issues.** |
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.
Or, other solution would be to create a couple of issues to fix the current warnings in documentation building.
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.
We can do both. From experience silencing all the sphinx warning would be nigh impossible, so I think it makes sense to remove this sentence.
rcap107
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.
This looks good! Thanks a lot @MarieSacksick 👍
I left a couple of comments, but aside from that I think it's already a big improvement
CONTRIBUTING.rst
Outdated
| .. | ||
| Given the number of warnings already present, I think it's very hard check to do and to enforce. | ||
| Shouldn't it be removed? |
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 think this can be removed
| ^^^^^^^^^^^ | ||
|
|
||
| Community consensus is key in the integration process. Expect a minimum | ||
| of 1 to 3 reviews depending on the size of the change before we consider |
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 would rather have something like "Expect a minimum of 1 to 3 reviews from maintainers..."
rcap107
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.
This looks good! Thanks a lot @MarieSacksick 👍
I left a couple of comments, but aside from that I think it's already a big improvement
Closes #1582
This issue says three things:
2 and 3 are tackled.

For 1, I quite like the contributing guide for now, because it's very detailed. Most of what I did is changing from:
to:
The idea is to go step by step for the contributor. Building the doc locally to me is part of checking the quality of contribution.