Improve contribution guide & readme, add code of conduct #5068
Conversation
nicolaskruchten
requested review from
emmanuelle,
antoinerg,
alexcjohnson,
jonmmease,
archmoj and
nicholas-esterer
|
Once this is merged in, we can add some extra links in the Plotly.py contributing guide to provide more of a trail of how to get features added to |
|
Yeah, once folks are OK with the prose, I'll sprinkle in some links. |
Co-authored-by: NickE <[email protected]>
|
Feedback incorporated, ready for more review from @antoinerg @jonmmease @emmanuelle :) |
|
I like it a lot! I don't see any changes needed. |
|
One idea would be to identify specific issues or pull requests that exemplify this process ... any nominations for issues that led to good discussions/proposals that were then implemented as community PRs? |
|
I expanded the top section a bit to provide a better "landing zone" for Python devs who land here wanting to contribute and needing orientation as to why they're in a JS project now :) |
|
@nicolaskruchten before merging, could you please fix the syntax? |
|
Also I appreciate if you change in this PR the https://github.com/plotly/documentation/blob/source/Contributing.md link to https://github.com/plotly/graphing-library-docs/blob/master/README.md in the |
|
@archmoj fixed, and did some fixup work on the readme |
README.md
Outdated
| |**MATLAB**| [plotly/matlab-api](https://github.com/plotly/matlab-api) | [plotly/matlab/getting-started](https://plotly.com/matlab/getting-started) | | ||
| |**node.js / Tonicdev / Jupyter notebook**| [plotly/plotly-notebook-js](https://github.com/plotly/plotly-notebook-js) | | | ||
|
|
||
| ## Creators | ||
| ## Maintainers |
There was a problem hiding this comment.
Let's maintain Creators in the title here.
What about Creators & maintainers?
There was a problem hiding this comment.
Why the attachment to "creators" ? I don't love that that excludes community contributors... Maintainer at least is a fairly formal role
There was a problem hiding this comment.
There are a number of people in the list below (including Plotly contractors in the Hall of Fame) who were not in charge of "maintaining" plotly.js; however their contribution was remarkable.
In respect to community contributors I suggest we add the link below to the bottom of list: https://github.com/plotly/plotly.js/graphs/contributors.
There was a problem hiding this comment.
How about Maintainers for the top list and Notable Contributors for the bottom list? I don't love that Jon Mease isn't in the "Hall of Fame" for example... he did add a whole trace type :)
There was a problem hiding this comment.
We should definitely add Jon Mease to the top list as an active contributor not the bottom list.
README.md
Outdated
|
|
||
| | | GitHub | Twitter | Status | | ||
| |---|--------|---------|--------| | ||
| |**Mojtaba Samimi** | [@archmoj](https://github.com/archmoj) | [@solarchvision](https://twitter.com/solarchvision) | Active, Maintainer | |
There was a problem hiding this comment.
No. This is rather confusing. I am sure I should not be listed on top of this list.
Let's maintain the Hall of Fame.
There was a problem hiding this comment.
There was a problem hiding this comment.
that was my reasoning as well, but I'm happy to switch out the top two
There was a problem hiding this comment.
Order switched.
code_of_conduct.md
Outdated
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [email protected] or [email protected]. All |
There was a problem hiding this comment.
I'd put another email of a specific person (for example Nicolas) and include full names (like "[email protected]" (Alex Johnson)) so that people are easy to identify / google.
CONTRIBUTING.md
Outdated
| 3. **Iteration** - The maintainers of the library or any other interested community member will then give feedback on the proposal, usually focused on consistency with the rest of the schema, and helping define a test plan to further elaborate potential edge cases. | ||
| 4. **Approval** - After a number of iterations, the maintainers of the library will generally approve a proposal with an informal "this seems like something we would accept a pull request for" comment in the issue. | ||
| 5. **Development** - A community member or maintainer creates a branch and makes the appropriate modifications to the code and tests and opens a pull request. | ||
| 6. **Review** - The maintainers of the library will review the pull request, working with the original authors to ensure the code is ready for merging. |
There was a problem hiding this comment.
| 6. **Review** - The maintainers of the library will review the pull request, working with the original authors to ensure the code is ready for merging. | |
| 6. **Review** - The maintainers of the library will review the pull request, working with the original authors to ensure the code is ready for merging. Iterations during review may take a bit of time, so be patient! In some cases it may also happen that the pull request cannot be merged for some reasons, but the process of starting by a discussion in an issue reduces the occurrence of this situation. |
There was a problem hiding this comment.
or something like that :-). I wanted to make sure that people know that it's not a completely linear process, sometimes unexpected difficulties arise, or life happens, or...
|
|
||
| Thanks for your interest in contributing to Plotly.js! We are actively looking for | ||
| diverse contributors, with diverse background and skills. | ||
|
|
There was a problem hiding this comment.
put here a few sentences explaining the organization of this document? It is quite long so it might be worth it. In particular some people will be looking specifically for out to set up a development environment.
|
Could you please add |
You can make these changes too if you like :) I actually think we should remove this bit about d3... it's not particularly helpful or informative IMO. |
I also think that line needs an update. |
|
@nicolaskruchten thanks for the input. |
nicolaskruchten
changed the title
Trying to make it a bit clearer how folks can contribute, so that we can link to this doc when saying "OK, the next step would be to propose some new attributes" or whatever :)