whatwg / meta

Discussions and issues without a logical home
Creative Commons Zero v1.0 Universal
93 stars 161 forks source link

Create a comprehensive list of steps for new contributors #232

Open annevk opened 2 years ago

annevk commented 2 years ago

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:

  1. Clone the repository. (Pointers to tools, etc.)
  2. Create a branch.
  3. 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.)
    • ?
  4. Optional, build it using make or make remote. (Pointers to additional information.)
  5. Commit your change following the COMMIT guidelines. We are very particular about our commit messages!
  6. Create a pull request. Only remove the template if your change is "Meta:" or "Editorial:" (see COMMIT guidelines).
  7. If you need tests and are willing to create them, see ...

Thoughts?

miketaylr commented 2 years ago

This looks like a good list. I'd be happy to help get something started here.

miketaylr commented 2 years ago

(I just found https://wpc.guide/bug-guide/, which I forgot existed - also pretty good)