meta
meta copied to clipboard
Create a comprehensive list of steps for new contributors
smaug pointed out on Matrix that currently our contributor information is scattered and anecdotally I think it's also clear that first-time contributors are not aware of all the various things we care about getting right.
So we should have some kind of list that describes the process.
Sketch:
- Clone the repository. (Pointers to tools, etc.)
- Create a branch.
- Edit the files you want to change. Typically this is
*.bs. While editing, ensure:- Proper formatting.
- Observe the Style Guide.
- Pointer to syntax guide. (Though follow local conventions.)
- ?
- Optional, build it using
makeormake remote. (Pointers to additional information.) - Commit your change following the COMMIT guidelines. We are very particular about our commit messages!
- Create a pull request. Only remove the template if your change is "Meta:" or "Editorial:" (see COMMIT guidelines).
- If you need tests and are willing to create them, see ...
Thoughts?
This looks like a good list. I'd be happy to help get something started here.
(I just found https://wpc.guide/bug-guide/, which I forgot existed - also pretty good)