Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 2.46 KB
Raw

How to contribute

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to AURA, which are hosted in the AURA Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. We want you working on things you're excited about and respect the Code Of Conduct

Here are some important resources:

  • AURA website tells you who and where we are, and
  • AURA Gitbook , give you acces to the technical documentation
  • AURA Current Sprint is our day-to-day project management plan for the incomming two weeks
  • AURA Global pilot study is an overview of what's needed for the MVP prototype to start the pilot study on 40 patients.
  • For sharing state of the art technology and be part of passionate discussions on healthcare future, Feel free to join us on Slack !
  • Found BUGS? Github issues is where to report them

An overview of the project

alt text

alt text As much as possible we try to write issues and user stories so that they match the flags of the diagram above

Testing

Travis CI is running after every commits and we have an overview of the code coverage using CodeCov.

Submitting changes

Please send a GitHub Pull Request to AURA mobile app with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include associated unit tests. We can always use more test coverage.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."