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

Set up contribution infrastructure for biojs repos #21

Open
4 tasks
DennisSchwartz opened this issue Jan 14, 2018 · 0 comments
Open
4 tasks

Set up contribution infrastructure for biojs repos #21

DennisSchwartz opened this issue Jan 14, 2018 · 0 comments

Comments

@DennisSchwartz
Copy link

DennisSchwartz commented Jan 14, 2018

Background

We should set up a formal process for contributing to biojs code repos.
That means the workman, the websites etc.

All input on this discussion is welcome. If there aren't any objections I will implement the process we use at Repositive and that seems to work very well for us.

Overview

  • The master branch is protected. Contribution can only happen through pull requests.
  • Pull requests need to be reviewed by a contributor
  • Pull requests are classed into three categories
    • [F] Code changes for enhancements or new features
    • [B] Bug fixes
    • [S] Support changes. README, settings, deployment files etc.
  • PRs are only merged using squashed commits. This provides a cleaner changelog.
  • Every PR needs to pass automated tests and linting.
  • Test coverage cannot decrease with PRs.
  • Test coverage needs to be at least 85% and are at the discretion of the reviewer.

Todo

  • Create CONTRIBUTE.md file with contribution guidelines
  • Setup Circle CI integration for tests
  • Setup test coverage testing
  • Setup linter and automated linting

Done

So far I have:

  • Enabled CircleCI for the biojs organisation
  • Set up testing environment and linter for the new workman repo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant