phac-nml / staramr

Scans genome contigs against the ResFinder, PlasmidFinder, and PointFinder databases.
Apache License 2.0
112 stars 25 forks source link

Add contribution guide #69

Open jennifertran opened 5 years ago

jennifertran commented 5 years ago

Currently, right now we don't have have a predefined standard for how Staramr is maintained or how someone can contribute to this project. I propose implementing a contribution guide that contains some of the following:

  1. How pull requests are made
  2. Staramr project workflow ex (we use travis for our builds)
  3. How developers can access to the debugging tools ex --verbose, logging, etc
  4. How to make sure units tests and linting scripts pass locally before submitting