Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GSoD Contributor Docs Editorial Changes #5764

Merged
merged 9 commits into from Sep 8, 2022

Conversation

limzykenneth
Copy link
Member

Changes:

This is a work in progress of GSoD project looking into the contributor docs and onboarding new contributors to p5.js. Please do leave any comments about the work currently being done below and I will be updating this PR regularly. This PR will only deal with editorial changes (ie. mainly text changes), more structural and build related changes will be filed as separate PR when I get to them.

For now I started by mapping the contributor's journey and the aim is to present only essential info for someone to get started while providing possibilities for further explorations. More details about how the contributor journey and overall structure will be documented below as I push the changes to this draft PR.

@limzykenneth
Copy link
Member Author

Latest set of commits archives some outdated or old contributor docs. Some of them are no longer relevant while some others are outdated and will be replaced with something else to come.

@limzykenneth
Copy link
Member Author

7d70c37 contains the latest on proposed stewards and maintainer guidelines. It is not meant for contributors (a separate one for contributors will be written) and it fairly detailed. It can be used as a checklist when reviewing issues and PR.

@limzykenneth
Copy link
Member Author

limzykenneth commented Aug 30, 2022

Just written contributor guidelines that is meant to serve as the starting point for any new contributor or existing contributor looking for information. Most of the information is contained within one document (contributor_guidelines.md) with only some links to other relevant documentation.

The main idea here is all information would be directly as easily accessible in this one document without having the need for the new contributor to look around for the right document. Comprehensive table of contents and suggestion of doing a page search should help with overall navigation of this long document as well.

Adding some graphics would be nice as well but I'll do that later, moving onto the build and release process docs/refactor.

@limzykenneth limzykenneth marked this pull request as ready for review September 6, 2022 17:17
@limzykenneth
Copy link
Member Author

Although this is not fully complete, I'm merging this for now as i'm moving over to work on the build and release process. I'll circle back to the documentation again after I've finished that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants