Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

53 lines (41 loc) · 2.18 KB
Raw

Calling all contributors!

The Coronavirus Diary project is endeavoring to aid the COV-SARS-2 response efforts by offering additional pre-screening capacity and data that can be used in tracking the spread of the virus. The pandemic is expanding rapidly and this project needs to ship as soon as possible.

The situation is escalating and we need your help!

You can help out by:

  • Reporting a bug
  • Reviewing the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Branches

We're using the following branches to manage work:

  • develop is semi-stable and should be used as the branch to fork from
  • master is stable and ready for prod (or it will be once we merge in the first release)
  • feature, bug branches: unstable development

How to report bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected to happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

We <3 thorough bug reports.

How to contribute code

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. We use a loose version of Git Flow and actively welcome your pull requests:

  1. Set up your local development environment. See USAGE.md for instructions.
  2. Make sure to use the latest Flutter stable-channel SDK release.
  3. Create a new branch based on develop:
    • Feature branches should start with feature/
    • Bugfix branches should start with bug/
  4. Implement your changes.
  5. Add tests if applicable.
  6. Make sure your code lints.
  7. Issue that pull request!

Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.