Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

59 lines (45 loc) · 2.99 KB
Raw

Contributing to Sense

How to become a contributor and submit your own code

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

We Develop with Github

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

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo through email.
  2. The repo owner will respond to your issue promptly.
  3. Fork the desired repo, develop and test your code changes.
  4. Ensure that your code adheres to the existing style in the sample to which you are contributing.
  5. Ensure that your code has an appropriate set of unit tests which all pass.
  6. Make a patch of the changes.
  7. Email the patch.

Any contributions you make will be under the Apache License 2.0.

In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.

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.

License

By contributing, you agree that your contributions will be licensed under Apache License 2.0. https://www.apache.org/licenses/LICENSE-2.0