Improve guide on working with the Paper source code
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
I think it could be nice to include more information on how to work with Paper's source code. This would include not only information for contributors, kinda how we already have the Events page, but also information regarding how to correctly fork Paper (use paperweight to do so) and maintain your own fork could be part of that category.
The following pages are what came to mind first. I wish to ask for anybody to suggest more pages or changes to these:
| Page name | Page content |
|---|---|
| Contributing to Paper | How to open a PR, what to watch out for, basically CONTRIBUTING.md in the main repo |
| Styling guidelines | Perhaps a dedicated page to certain guidelines, like imports, // Paper comments, and similar |
| Forking Paper | A page explaining how to create and maintain your own fork of Paper using paperweight |
Opening this as an issue first, since I want to have some input whether anybody thinks this is really needed in the first place. We already have this one Events contribution page without much context around it, so I think it could be good to extend onto that.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Events contribution page and CONTRIBUTING.md in the main repository, then examine how paperweight is used to fork and maintain Paper. Confirm the desired scope with the requested input before documenting the proposed contributing, styling-guidelines, and forking pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100