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

Write CONTRIBUTING.md #43

Open
ryanrolds opened this issue May 30, 2020 · 0 comments
Open

Write CONTRIBUTING.md #43

ryanrolds opened this issue May 30, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ryanrolds
Copy link
Owner

ryanrolds commented May 30, 2020

  • Include the link to Discord.
  • Encourage people to talk with us in discord before submitting PRs.
  • Outline how to start the services from the root as well as how to start them in each of the subdirs.
  • Include instructions on how to run tests and linters from root and subdirs.
  • Master on the main repo is assumed to be stable at all times
  • Everyone works in branches (on a fork or not - personal preference thing)
  • PRs that are not ready to review are kept in the "Draft" state (it is possible to switch a non-draft to a draft - there is a button under the review list in the PR).
  • PRs that are not in a Draft state read ready to be reviewed
  • At least one review is required to merge, but large PRs or PRs making arch changes should consider getting at least 2 reviewers
  • All PRs should include reasonable test coverage is the changes are setup for tests
  • Linting must pass
  • Once approved by reviewer(s), the author merges to master(edited)
  • Work should have a related ticket, which holds the conversation about the work
@ryanrolds ryanrolds added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant