Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: reorganizing contributing docs to clean up toc, better separate topics#27265
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
c283644
to9053d14
Compare3c30056
to3be520a
Comparedc5d794
to6522557
CompareUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
story645 commentedDec 10, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Just want to mention that the only new content here is the documentation and coding section of the contribute guide & I'm not super attached to the language, I just wanted some content there to establish that the scope of that page is supposed to be introductory background/context setting/roadmapping for contributing and that other pages are where they can find the coding/doc/etc guides. |
@timhoffm you might want to skim this since I move around the API guidelines a bit, but I don't change any guidelines. The changes I made specifically are:
|
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
0723cb5
to81fdb40
Comparef006688
to283e299
CompareUh oh!
There was an error while loading.Please reload this page.
doc/devel/triage.rst Outdated
@@ -11,24 +12,28 @@ identifying major projects to work on, and discussing priorities. For | |||
this reason, it is important to curate the issue list, adding labels | |||
to issues and closing issues that are resolved or unresolvable. | |||
Improving issues increases their chances of being successfully resolved. |
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 find "Improving issues" somewhat confusing, because it can have one of the two meanings:
- work towards solving the issue (= improving an issue of the library)
- work towards improving the issue description.
Would "Improving issue reports" be ok?
Take or leave as this has been there before. We want to take quick improvements along the way, but don't want to get lost in details.
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.
reworking this language to try and make it clearer its about writing the issue.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
create seperation between guidelinesmake contributing guide more newbie orientedstreamline triage guidemoved api guide out of coding guidelinesCo-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
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.
LGTM.
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free tosuggest an improvement. |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free tosuggest an improvement. |
Removed the backport as doing this manually is not worth is IMHO. |
Bonus ofmatplotlib/matplotlib.org#36 is that there's often no need to backport dev docs anymore 😁 |
Uh oh!
There was an error while loading.Please reload this page.
This is in the vein of#26196 and the high level improvement is that via reorganizing:
top card of the contribute landing page == roadmapped index into contribute.rst
each card in the policies and guidelines page is now a toctree:
Also much better left hand side since I understand how to make those now thanks to@jklymak (yes it took me this long to sort out that LHS goes by toctrees, like RHS goes by headers):
The other changes are:
https://output.circle-artifacts.com/output/job/d52e9e4d-a1b5-4271-9859-e6310853f31f/artifacts/0/doc/build/html/devel/coding_guide.html
PR summary
PR checklist