Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 1.88 KB

CONTRIBUTING GUIDELINES.md

File metadata and controls

35 lines (31 loc) · 1.88 KB
Raw

Contributing to MTIP – Cameo Plugin

We value your contributions and suggestions! 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

We Develop with Github

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

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue. Write bug reports with detail, background, and sample code. Reports should include (not required):

  • 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)

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!

Tests

We have not developed any standardized testing. Any help with this is greatly appreciated.

Any contributions you make will be under the Apche 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.

This document was adapted from the open-source contribution guidelines for Facebook's Draft