Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

DOC: Move bug reports and feature requests to top of contributing index#28011

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

Merged
timhoffm merged 1 commit intomatplotlib:mainfromtimhoffm:doc-contribute
Apr 4, 2024

Conversation

timhoffm
Copy link
Member

@timhoffmtimhoffm commentedApr 2, 2024
edited
Loading

Partially adresses#28005.

The two sections "Report a bug" and "Request a feature" were burried inside of contribute.rst. They were a bit foreign there because all other content is on direct involvement with the project, which needs much more information.

To keep things focussed and directly redirect the "simple" bug report and feature request topics to GitHub, I've deleted the sections and instead created two cards at the top of devel/index.rst with essentially the content of the sections. Note that I've removed the list of things to include in bug reports because that's covered by our issue template on GitHub nowadays and does not need repetition here.

@story645
Copy link
Member

story645 commentedApr 2, 2024
edited
Loading

Um so it's in contribute b/c we say in the "other ways to contribute" section that filing bug reports and feature requests are ways to contribute. Which putting it as a subsection of that might make more sense - or on the triage page.

I'm very wary about adding specific content to the index pages b/c I think that's how they start to grow "oh and also what about this"

ETA: I'm kinda net-neutral in that I'm concerned about organization but also understand this as a short cut.

story645
story645 previously requested changesApr 3, 2024
@timhoffm
Copy link
MemberAuthor

timhoffm commentedApr 3, 2024
edited
Loading

I'm very wary about adding specific content to the index pages b/c I think that's how they start to grow "oh and also what about this"

ETA: I'm kinda net-neutral in that I'm concerned about organization but also understand this as a short cut.

I first thought to extract the two sections to a different page. But since I wanted a tiny bit of context directly in the card (not only a bare button "Create a pull request"), the card more or less duplicated the sections on the separate page. In case we'd want more information in the future, we are free to add that page.

Also from a conceptual point, we should not have too much specific information on issue and PR creation in the docs. Not everybody comes through the docs. Thus, it is better if relevant information is in the PR template, so that everybody gets it. I therefore find it justified to take the shortcut here.

story645 reacted with thumbs up emoji

Copy link
Member

@story645story645 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

So this might be better for a follow up issue, but in line w/ why I think that paragraph should stay up top, I think this paragraph should get moved to right under the "new contributors" heading

If you are new to contributing, we recommend that you first read ourcontributing guide. If you are contributing code or documentation, please follow our guides for setting up and managing adevelopment environment and workflow. For code, documentation, or triage, please follow the correspondingcontribution guidelines.

Comment on lines 66 to 71
We also welcome you to get more involved with the Matplotlib project.
There are various ways to contribute:
optimizing and refactoring code, detailing unclear documentation and writing new
examples, reporting and fixing bugs and requesting and implementing new features,
helping the community...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I still think this should be on the top since it's the lead in/why for reading the whole page. I

Suggested change
We also welcome you to get more involved with the Matplotlib project.
There are various ways to contribute:
optimizing and refactoring code, detailing unclear documentation and writing new
examples, reporting and fixing bugs and requesting and implementing new features,
helping the community...
We welcome you to get more involved with the Matplotlib project.
There are various ways to contribute:
optimizing and refactoring code, detailing unclear documentation and writing new
examples, helping the community, reporting and fixing bugs and requesting and implementing new features...

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I was thinking in the direction of separating simple feedback in form of issues and feature requests from direct involvement in the project, because I believe people have a quite clear idea whether they want to do the one or the other.

How about adding sections

  • Bug reports and feature requests
  • Contributing to Matplotlib

and putting the above text in the second section?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The preamble is explicitly saying that bugs and features are forms of contributing...like the primary reason I'm saying to put it up top is b/c otherwise we're repeating the same language anyway since landing pages need a context setting preamble anyway.

We welcome you to get more involved with the Matplotlib project.
There are various ways to contribute:
optimizing and refactoring code, detailing unclear documentation and writing new
examples, helping the community, reporting and fixing bugs and requesting and implementing new features...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

but also I get if I'm gonna just have to show what I mean in a follow on PR

Copy link
MemberAuthor

@timhoffmtimhoffmApr 4, 2024
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

IMHO the main issue here is that "contributing" is used in two ways.

logical: Ageneral contribution is one of two types

  • posting an issue or feature request
  • actively working with the code/documentation/community

The first is more like giving a feedback with no intention of longer relationship. The second involves getting to know the project structures and is thus far more complex. I would really like to distinguish the two types, because the relevant information for the two target groups is significantly different and by clearly distinguishing between them, we can provide exactly the required information for each.

I feel we are missing a good terminology for the cases here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I would really like to distinguish the two types, because the relevant information for the two target groups is significantly different and by clearly distinguishing between them, we can provide exactly the required information for each.

I get what you're saying but also we're putting them on the same page so I don't think that the answer is adding another layer of hierarchy or burying the preamble. Though hmm, thinking about this more, maybe just removing this line since we literally invite folks to do it in the next two boxes may help with the flow a bit:

As a user, you can give valuable feedback by reporting bugs and suggesting features

And possibly making the border color around 'bugs + issues' different or turning the other cards into grids - making this a primarily visual distinction.

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I've removed the sentence. The bugs and features cards have a shadow and an icon in the heading. IMHO this makes them visually distinct from other cards on the page - in particular the shadow also detaches the cards from the otherwise flat content of the page. I'm a bit hesitant to play with colors too much.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

ok, I can mess around w/ the other cards in the follow up I think I'm making to tackle a couple of things.

timhoffm reacted with thumbs up emoji
Partially adressesmatplotlib#28005.The two sections "Report a bug" and "Request a feature" were burriedinside of contribute.rst. They were a bit foreign there because allother content is on direct involvement with the project, which needsmuch more information.To keep things focussed and directly redirect the "simple" bug reportand feature request topics to GitHub, I've deleted the sections andinstead created two cards at the top of devel/index.rst withessentially the content of the sections. Note that I've the list ofthings to include in bug reports because that's covered by our issuetemplate on GitHub nowadays and does not need repetition here.Co-authored-by: hannah <story645@gmail.com>
@timhoffmtimhoffm added this to thev3.9.0 milestoneApr 4, 2024
@timhoffmtimhoffm merged commit69f9ebf intomatplotlib:mainApr 4, 2024
@timhoffmtimhoffm deleted the doc-contribute branchApril 4, 2024 22:04
@story645story645 mentioned this pull requestApr 5, 2024
5 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@story645story645story645 approved these changes

Assignees
No one assigned
Labels
Documentation: devdocsfiles in doc/devel
Projects
None yet
Milestone
v3.9.0
Development

Successfully merging this pull request may close these issues.

2 participants
@timhoffm@story645

[8]ページ先頭

©2009-2025 Movatter.jp