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

Document coding standards #15

Open
jensren opened this issue Nov 8, 2021 · 0 comments
Open

Document coding standards #15

jensren opened this issue Nov 8, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation repo Setting up the repo

Comments

@jensren
Copy link
Collaborator

jensren commented Nov 8, 2021

What: put some coding standards guidelines on the wiki

Why: hopefully have a cleaner code base and spend less time advising people manually on what to do. Instead we can just say 'please refer to this part of the wiki'

Implementation details: some things we want to write down (more experienced devs might already know this, but not all devs will):

  • How to fork and PR (link to some guide)
  • PR guidelines: what should they write
  • Pull from main frequently, and pull and resolve conflicts before submitting a PR
  • All PRs must not have lint warnings and must build to be accepted
  • Commit message guidelines: probably link to some guide, and an example of what we want in case they don't want to read the guide
  • Run the linter before pushing (how to use eslint, running yarn lint)
  • Other things?
@jensren jensren added documentation Improvements or additions to documentation repo Setting up the repo labels Nov 8, 2021
@jensren jensren self-assigned this Nov 14, 2021
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 repo Setting up the repo
Projects
None yet
Development

No branches or pull requests

1 participant