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

Create a comprehensive list of steps for new contributors #232

Open
annevk opened this issue Nov 5, 2021 · 2 comments
Open

Create a comprehensive list of steps for new contributors #232

annevk opened this issue Nov 5, 2021 · 2 comments

Comments

@annevk
Copy link
Member

annevk commented Nov 5, 2021

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
Copy link
Member

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

@miketaylr
Copy link
Member

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

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

No branches or pull requests

2 participants