Improve Readme for future Contributors to codebase #6260
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nbriz
suggested changes
Jul 10, 2023
There was a problem hiding this comment.
This is great @Ayush23Dash, as a newbie to the p5.js repo myself i also got a bit lost when trying to find the answer to this question (so great that p5 has such thorough documentation, but flip side is that these v important + starter steps were hard to find). i agree that this info belongs in the README.md but need to refer to others to make the final call on this (@Qianqianye what do u think?)
if we do decide to keep it here, besides the small type-o i mentioned below, the only other thing i might suggest changing is the order of where this (&& other sections) fall in the README, rather than:
- Community
- Get Started
- Get Started for Developers
- Issues
- Learning
- Stewards
- Contributors
i'd suggest we put all the "user" focused sections on top of the "contributor" focused sections, so maybe something like this:
- Community
- Get Started
- Learning
- Issues
- Get Started (for Code/Doc Contributors)
- Stewards
- Contributors
also, the dev setup steps u list out in the new section u added look right to me, but maybe someone w/a bit more experience setting up the dev environment should give it a second look, @almchung @outofambit?
README.md
Outdated
| 7. As you start making changes to the codebase, frequently run : | ||
| `npm test` | ||
| (it takes time, but it ensures that existing behaviours are not being broken) | ||
| 8. Once it is done, you can commit the changes and create a Pull Request. |
There was a problem hiding this comment.
might also be helpful to link "Pull Request" to these corresponding docs?
README.md
Outdated
| (it takes time, but it ensures that existing behaviours are not being broken) | ||
| 8. Once it is done, you can commit the changes and create a Pull Request. | ||
|
|
||
| If you are still not sure, how to star with contributing to P5🌸 do not worry we have got you covered, detailed information present [here](https://p5js.org/contributor-docs/#/./contributor_guidelines). |
There was a problem hiding this comment.
type-o "star" should be "start"
|
Hi @nbriz, I worked on your suggestions and committed it to the PR. As you mentioned, it would be great to have reviews from @almchung @Qianqianye @outofambit @limzykenneth as well! |
|
@limzykenneth Since this change will be also applied to the general-level contributions, it would be great to have you review it too. Thank you! |
limzykenneth
requested changes
Jul 31, 2023
| ## Using the GitHub edit functionality | ||
| When viewing a file on the GitHub web interface, near the top of the content of the file you are viewing will be a pencil icon button. This button is a convenient edit feature provided by GitHub that simplifies many of the processes we will be covering below and can be used to make quick and simple edits to the file you are viewing. | ||
| ## Quick Get Started For Developers | ||
| If you want to work/contribute to P5's🌸 codebase as a developer, either directly for improving P5 or for improving it's sub projects like [Friendly Error Systems](https://github.com/processing/p5.js/blob/main/contributor_docs/friendly_error_system.md), you can follow the following steps directly : |
There was a problem hiding this comment.
Last one with P5 -> p5.js, then we can merge. Thanks.
…for-future-contributors
|
Looks good. Thanks! |
AmrikSD
pushed a commit
to Potato-Blood/pogo
that referenced
this pull request
Nov 10, 2023
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [p5](https://togithub.com/processing/p5.js) | devDependencies | minor | [`1.7.0` -> `1.8.0`](https://renovatebot.com/diffs/npm/p5/1.7.0/1.8.0) | | [@types/p5](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/p5) ([source](https://togithub.com/DefinitelyTyped/DefinitelyTyped)) | devDependencies | patch | [`1.7.0` -> `1.7.3`](https://renovatebot.com/diffs/npm/@types%2fp5/1.7.0/1.7.3) | --- ### Release Notes <details> <summary>processing/p5.js (p5)</summary> ### [`v1.8.0`](https://togithub.com/processing/p5.js/releases/tag/v1.8.0) [Compare Source](https://togithub.com/processing/p5.js/compare/v1.7.0...v1.8.0) <!-- Release notes generated using configuration in .github/release.yml at v1.8.0 --> #### What's Changed 🎊 ##### WebGL In this release, p5.js added some new WebGL mode tools. Filters now run in shaders for extra speed, and you can now run custom filter shaders, even on 2D canvases. You can now cut holes in shapes with `beginContour()` and apply vector masks with `beginClip()`. You can reuse shapes more efficiently with `buildGeometry()` and instanced rendering. Finally, we have also fixed a number of bugs. *- Summary written by [@​davepagurek](https://togithub.com/davepagurek) ✨* - Add support for beginContour() and endContour() in Webgl mode by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6297 - Fix stroke rendering when drawing to framebuffers by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6304 - Adds createFilterShader() and custom shader support to the webGL filter() function by [@​wong-justin](https://togithub.com/wong-justin) in [processing/p5.js#6237 - Fix WebGL text not rendering when rotated 90 degrees by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6316 - Fix reading between nested active framebuffers by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6314 - Add methods to construct p5.Geometry from other p5 drawing functions by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6287 - Handle missing exact edge vertices in buildGeometry by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6320 - Fix strokes on framebuffers with different aspect ratios by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6339 - Fix freed geometry leaving attributes in a broken state by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6323 - Improve performance of line rendering by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6230 - Add support for webGL instancing by [@​RandomGamingDev](https://togithub.com/RandomGamingDev) in [processing/p5.js#6276 - Add shaders for filter() constants, and use them by default in P2D by [@​wong-justin](https://togithub.com/wong-justin) in [processing/p5.js#6324 - Fix clip() on both the main canvas and framebuffers by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6376 - fixed texture filtering bug in p5.Framebuffer by [@​KeyboardSounds](https://togithub.com/KeyboardSounds) in [processing/p5.js#6420 - Fix clear() on framebuffers on Intel macs by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6429 - Fix textureMode(IMAGE) + beginShape(TESS) by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6366 - fixed issue [#​6440](https://togithub.com/processing/p5.js/issues/6440) by [@​Gaurav-1306](https://togithub.com/Gaurav-1306) in [processing/p5.js#6446 - Erode, dilate, threshold shader filters match closer to CPU filters by [@​wong-justin](https://togithub.com/wong-justin) in [processing/p5.js#6405 - Update WebGL blur filter to match CPU blur more by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6460 - Fix camera flipping on framebuffers between push/pop calls by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6471 - Setuniform by [@​Gaurav-1306](https://togithub.com/Gaurav-1306) in [processing/p5.js#6474 - resolved issue [#​6399](https://togithub.com/processing/p5.js/issues/6399) by [@​Gaurav-1306](https://togithub.com/Gaurav-1306) in [processing/p5.js#6480 - Auto-bind filter shaders to the filter graphic by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6482 - new PR for issue [#​6383](https://togithub.com/processing/p5.js/issues/6383)(Problem for diagonal) by [@​perminder-17](https://togithub.com/perminder-17) in [processing/p5.js#6488 ##### Friendly Error System (FES) - Add Hindi translation to FES by [@​Ayush23Dash](https://togithub.com/Ayush23Dash) in [processing/p5.js#6272 - Re-worded lines 413 and 446 of FES Developer Notes by [@​OnexiMedina](https://togithub.com/OnexiMedina) in [processing/p5.js#6307 - Reference FES Contributor Docs inside FES Directory along with a diagram to understand usages of FES functions by [@​Ayush23Dash](https://togithub.com/Ayush23Dash) in [processing/p5.js#6335 - Fixed typing errors in fes_core.js documentation by [@​Garima3110](https://togithub.com/Garima3110) in [processing/p5.js#6478 - Update friendly_error_system.md by [@​Garima3110](https://togithub.com/Garima3110) in [processing/p5.js#6481 - Update fes_reference_dev_notes.md by [@​Garima3110](https://togithub.com/Garima3110) in [processing/p5.js#6486 ##### Reference Documentation Update We updated a group of p5.js Reference pages as part of 2023 Season of Docs (SoD) program, with a goal to make them more accessible and beginner-friendly. Thanks to the SoD technical writer [@​nickmcintyre](https://togithub.com/nickmcintyre) ✨. - Edit docs for math functions by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6281 - docs(typography): fix typos in example for textFont by [@​meezwhite](https://togithub.com/meezwhite) in [processing/p5.js#6401 - Edit docs for p5.Vector by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6340 - Edit docs for pixels functions by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6390 - Edit docs for loading & displaying images by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6425 - Update docs for p5.Image by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6434 - Edit docs for p5.Font by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6453 - Edit docs for image by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6424 - Edit docs for typography load and display by [@​nickmcintyre](https://togithub.com/nickmcintyre) in [processing/p5.js#6450 ##### Google Summer of Code (GSoC) 2023 Wrap up - 🌸 Added GSoC wrap up! by [@​dewanshDT](https://togithub.com/dewanshDT) in [processing/p5.js#6403 - Gsoc 23 Wrapup post by [@​Ayush23Dash](https://togithub.com/Ayush23Dash) in [processing/p5.js#6415 - add GSoC'23 wrapup post for Justin Wong by [@​wong-justin](https://togithub.com/wong-justin) in [processing/p5.js#6418 - Create lichlyter_gsoc\_2023.md by [@​katlich112358](https://togithub.com/katlich112358) in [processing/p5.js#6455 - Create munusshih_gsoc\_2023.md by [@​munusshih](https://togithub.com/munusshih) in [processing/p5.js#6461 ##### Other Code Update - Ask to disable printing when print() called with no arguments by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6253 - fix textWidth() and textToPoints() by [@​munusshih](https://togithub.com/munusshih) in [processing/p5.js#6184 - Fix issue where nf with 0 'right' parameter returns undefined in string by [@​limzykenneth](https://togithub.com/limzykenneth) in [processing/p5.js#6291 - Update environment.js with fix for frameRate description by [@​quinton-ashley](https://togithub.com/quinton-ashley) in [processing/p5.js#6269 - Implement clip() to shapes by [@​davepagurek](https://togithub.com/davepagurek) in [processing/p5.js#6306 - Clarified workflow for contributing documentation by [@​thatguyseven](https://togithub.com/thatguyseven) in [processing/p5.js#6312 - Clears MediaElement canvas at the beginning of every frame by [@​donaldzhu](https://togithub.com/donaldzhu) in [processing/p5.js#6309 - Clean up gruntfile release related steps by [@​Qianqianye](https://togithub.com/Qianqianye) in [processing/p5.js#6321 - fix-return-type by [@​asukaminato0721](https://togithub.com/asukaminato0721) in [processing/p5.js#6326 - fix HALF_FLOAT by [@​asukaminato0721](https://togithub.com/asukaminato0721) in [processing/p5.js#6330 - Added .gitattributes to Increase compatability with Window users and line endings by [@​SilasVM](https://togithub.com/SilasVM) in [processing/p5.js#6317 - update all contributors setup by [@​gr2m](https://togithub.com/gr2m) in [processing/p5.js#6341 - refine canvas' type by [@​asukaminato0721](https://togithub.com/asukaminato0721) in [processing/p5.js#6328 - MouseEvent, WheelEvent and KeyboardEvent type by [@​asukaminato0721](https://togithub.com/asukaminato0721) in [processing/p5.js#6329 - fixed-wrong-capture-size-and-freeze-issue by [@​Prateek93a](https://togithub.com/Prateek93a) in [processing/p5.js#5159 - add more event type by [@​asukaminato0721](https://togithub.com/asukaminato0721) in [processing/p5.js#6379 - Main by [@​j-adel](https://togithub.com/j-adel) in [processing/p5.js#6374 - Update labeler Github Action by [@​stampyzfanz](https://togithub.com/stampyzfanz) in [processing/p5.js#6395 - add unregisterMethod function by [@​capGoblin](https://togithub.com/capGoblin) in [processing/p5.js#6426 - add before/after preload and setup by [@​capGoblin](https://togithub.com/capGoblin) in [processing/p5.js#6433 - Fix: Misleading error message when NaN passed by [@​capGoblin](https://togithub.com/capGoblin) in [processing/p5.js#6464 - Support pixel density on p5.Image (fixes issue [#​6114](https://togithub.com/processing/p5.js/issues/6114)) by [@​Gaurav-1306](https://togithub.com/Gaurav-1306) in [processing/p5.js#6447 - Fix orphan canvas when sketch is removed before canvas creation by [@​limzykenneth](https://togithub.com/limzykenneth) in [processing/p5.js#6355 ##### Other Documentation Update - Fixed GitHub capitalization typo in contributor_docs by [@​SilasVM](https://togithub.com/SilasVM) in [processing/p5.js#6284 - Fixing typo in "What are issues?" by [@​snwarner22](https://togithub.com/snwarner22) in [processing/p5.js#6288 - Fixed GitHub spelling in CONTRIBUTING.md by [@​SilasVM](https://togithub.com/SilasVM) in [processing/p5.js#6295 - Fixed grammatical errors in contributor_guidelines.md by [@​thatguyseven](https://togithub.com/thatguyseven) in [processing/p5.js#6296 - Update documentation_style_guide.md with new guideline by [@​zelf0](https://togithub.com/zelf0) in [processing/p5.js#6334 - add missing code contributors to all contributors in README and `.all-contributors.rc` file by [@​gr2m](https://togithub.com/gr2m) in [processing/p5.js#6349 - docs(all-contributors): remove [@​stellartux](https://togithub.com/stellartux) as requested by [@​gr2m](https://togithub.com/gr2m) in [processing/p5.js#6368 - docs(src/utilities): Use `describe()` instead of `@alt` by [@​Zearin](https://togithub.com/Zearin) in [processing/p5.js#5598 - Fix typo in export path to fix dev mode by [@​mykongee](https://togithub.com/mykongee) in [processing/p5.js#6373 - Improve Readme for future Contributors to codebase by [@​Ayush23Dash](https://togithub.com/Ayush23Dash) in [processing/p5.js#6260 - Fixed mousePressed() Example Error by [@​Utkarsh3128](https://togithub.com/Utkarsh3128) in [processing/p5.js#6413 - Update README.md by [@​katlich112358](https://togithub.com/katlich112358) in [processing/p5.js#6458 - Fixed typing errors in validate_params.js file's documentation by [@​Garima3110](https://togithub.com/Garima3110) in [processing/p5.js#6473 - typo and unused variable from core by [@​benschac](https://togithub.com/benschac) in [processing/p5.js#6476 #### New Contributors 💗 - [@​munusshih](https://togithub.com/munusshih) made their first contribution in [processing/p5.js#6184 - [@​SilasVM](https://togithub.com/SilasVM) made their first contribution in [processing/p5.js#6284 - [@​snwarner22](https://togithub.com/snwarner22) made their first contribution in [processing/p5.js#6288 - [@​thatguyseven](https://togithub.com/thatguyseven) made their first contribution in [processing/p5.js#6296 - [@​OnexiMedina](https://togithub.com/OnexiMedina) made their first contribution in [processing/p5.js#6307 - [@​donaldzhu](https://togithub.com/donaldzhu) made their first contribution in [processing/p5.js#6309 - [@​gr2m](https://togithub.com/gr2m) made their first contribution in [processing/p5.js#6341 - [@​RandomGamingDev](https://togithub.com/RandomGamingDev) made their first contribution in [processing/p5.js#6276 - [@​mykongee](https://togithub.com/mykongee) made their first contribution in [processing/p5.js#6373 - [@​j-adel](https://togithub.com/j-adel) made their first contribution in [processing/p5.js#6374 - [@​meezwhite](https://togithub.com/meezwhite) made their first contribution in [processing/p5.js#6401 - [@​dewanshDT](https://togithub.com/dewanshDT) made their first contribution in [processing/p5.js#6403 - [@​Utkarsh3128](https://togithub.com/Utkarsh3128) made their first contribution in [processing/p5.js#6413 - [@​KeyboardSounds](https://togithub.com/KeyboardSounds) made their first contribution in [processing/p5.js#6420 - [@​capGoblin](https://togithub.com/capGoblin) made their first contribution in [processing/p5.js#6426 - [@​Gaurav-1306](https://togithub.com/Gaurav-1306) made their first contribution in [processing/p5.js#6446 - [@​katlich112358](https://togithub.com/katlich112358) made their first contribution in [processing/p5.js#6455 - [@​Garima3110](https://togithub.com/Garima3110) made their first contribution in [processing/p5.js#6473 - [@​benschac](https://togithub.com/benschac) made their first contribution in [processing/p5.js#6476 - [@​perminder-17](https://togithub.com/perminder-17) made their first contribution in [processing/p5.js#6488 - [@​lakshay451](https://togithub.com/lakshay451) made their first contribution in [processing/p5.js#6493 **Full Changelog**: processing/p5.js@v1.7.0...v1.8.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMS4wIiwidXBkYXRlZEluVmVyIjoiMzcuMzUuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: Renovate Bot <bot@renovateapp.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem :
Currently as a new contributor to the codebase of P5, it becomes very difficult in order to navigate through various links from the Readme to finally get to the document that helps the contributor set up P5 locally and enable the contributor to make changes and create a PR.
Adding the documentation directly into the Readme on the front of repository would help the future contributors to directly get to work!!
Changes:
Improve Readme for future Contributors to codebase.
npm run lintpasses