add non-code contributions to contrib guidelines readme #6941
Conversation
Contributor docs update, requested by Q and Ken
|
🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page! |
|
|
||
| ## Non-source code contribution | ||
| There are many more ways to contribute to p5.js through non-source code contribution than can be exhaustively listed here, some of the ways may also involve working with some of the p5.js repositories (such as adding examples, writing tutorials for the website, etc.). Depending on what the planned contribution is, we may be able to support you in different ways so do reach out to us via any channel available to you (email, social media, [Discourse forum](https://discourse.processing.org/c/p5js/10), Discord, etc). | ||
| There are many more ways to contribute to p5.js through non-source code contribution than can be exhaustively listed here. Some of the ways may also involve working with some of the p5.js repositories (such as adding examples, writing tutorials for the website, etc.). Depending on what the planned contribution is, we may be able to support you in different ways so do reach out to us via any channel available to you (email, social media, [Discourse forum](https://discourse.processing.org/c/p5js/10), Discord, etc). Here are just some ways you can contribute: |
There was a problem hiding this comment.
Hi @sarahciston, we mentioned earlier that documentation is part of Source-code contribution, so we will need to move the documentation related text up. What do you think?
There was a problem hiding this comment.
I agree, and in that case we'd want to provide more introduction to documentation contributions there as well, right? On the website contribution page it says, "Document. Everyone loves helpful instructions. Check out the p5.js GitHub on how to get started with creating examples, improving reference pages, and writing tutorials." So where can we point to specifically for showing how to get started with writing reference pages and docs?
There was a problem hiding this comment.
We can point them to Contribute page on the new website
There was a problem hiding this comment.
On the Contribute page on the new website it points them to the GitHub contributor docs. Is there a place in the docs that addresses creating documentation specifically? Maybe we could point them to that? If not, perhaps that's something we could build in the future if it's desirable, but may need to remove the description of the pointer from the website if we don't have info on how to get started writing documentation yet. What do you both think? @Qianqianye @limzykenneth
There was a problem hiding this comment.
We have a doc about how to write reference, and upcoming doc about how to write examples. They both will be on the contribute page. We will have new links when the new website is updated. Maybe we can just mention the contribute page generically without links for now?
|
Hi @limzykenneth, because the README.md file is quite long with the details about source-code contribution. I'm not sure if it still makes sense to have it as the intro text on the contribute page for the new website. The backup plan is to have this README.md file as an individual contributor doc item. What do you think? |
| @@ -1,8 +1,8 @@ | |||
| # 🌸 Welcome! 🌺 | |||
|
|
|||
| Thanks for your interest in contributing to p5.js! Our community values contributions of all forms and seeks to expand the meaning of the word "contributor" as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. [Our community page](https://p5js.org/community/#contribute) gives an overview of some different ways to get involved and contribute. | |||
| Thanks for your interest in contributing to p5.js! p5.js is a collaborative project with contributions from many volunteers. Our community is always looking for contributors and appreciates involvement in all forms. We acknowledge that not everyone has the capacity, time, or financial means to participate actively or in the same ways. We want to expand the meaning of the word “contributor.” Whether you're an experienced developer or just starting out, we value your involvement. Your unique perspectives, skills, and experiences enrich our community, and we encourage you to get involved in a way that works for you. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. Our [contribute page](https://p5js.org/contributor-docs/#/) gives an overview of different ways to get involved and contribute. | |||
There was a problem hiding this comment.
@sarahciston I made some edits on some other paragraphs to combine the new writing you had and some existing text. Please feel free to make edits.
| - Contributions that directly deals with the source code (including documentation) | ||
| - Contributions that directly deals with the source code very little or not at all | ||
| - Source code contribution (including documentation) | ||
| - Non-source code contribution | ||
|
|
There was a problem hiding this comment.
I change the two category title to the chapter titles. If it's making things easier, we can remove 'including documentation' in 'Source code contribution,' and include it in 'Non-source code contribution' chapter.
There was a problem hiding this comment.
I like keeping "including documentation". And would also like to add to 'non code contributions' (see below) so it's more clear where to find out about that.
|
We'll still need copy for the contribute page in any case, if this one is too long we can ignore it for the website and just let it live in this repo only and have something shorter on the website. |
| - Contributions that directly deals with the source code (including documentation) | ||
| - Contributions that directly deals with the source code very little or not at all | ||
| - Source code contribution (including documentation) | ||
| - Non-source code contribution | ||
|
|
There was a problem hiding this comment.
I like keeping "including documentation". And would also like to add to 'non code contributions' (see below) so it's more clear where to find out about that.
Requested by Q and Ken, inserted edited text for non-code ways to contribute at bottom of README.md
@all-contributors please add @sarahciston for [doc]