Skip to content

Latest commit

 

History

History
executable file
·
39 lines (31 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
39 lines (31 loc) · 1.81 KB
Raw

Contributing to Transcriptase

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

How To Contribute

  1. Fork the repo and create your branch from main.
  2. Create a branch with your resource: git checkout -b my-feature
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Commit your changes: git commit -m 'feat: My new feature'
  8. Push your branch: git push origin my-feature
  9. Create a PR and fill in the pull request information
  10. Submit PRs to help solve issues or add features

Report bugs using Github's issues

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

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.