Update Contributor Guidelines text #732
Description
Goal
The contributor guidelines page could use a refresh to make it more streamlined and approachable for new contributors.
Actions
- Rename to “Ways to Contribute”
- link directly to a new issue https://github.com/icesat2py/icepyx/issues/new
- Reorganize sections (see Notes section)
- Add mermaid diagram of types of contributions to break up text with visuals
Notes
Copied from the Birdardo training Google docs and moved here for visibility and tracking
- RW: does “[contributing code(https://icepyx.readthedocs.io/en/latest/contributing/contribution_guidelines.html#contributing-code)” belong on the How to Contribute page? AS: I had the same thought. I wonder if this should link over to How to Contribute, nested under this page. And to keep the context consistent, rename to “How to Contribute Code”? Since there are other ways to contribute as we describe here. To me it flows like: Contribution Guidelines as a high-level overview of the types of contributions. Then, once you get into contributing code, that requires more detailed documentation.
- RW: jargon? ”share your use cases and examples”