Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 2.66 KB
Raw

Contributing to MBT Bundle

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

  • Reporting a bug
  • Updating documentation (wiki)
  • Discussing the current state of the code
  • Discussing about the future of the project
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, documentation, 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!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License 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!

Note: We track all issues (code, documentation, infrastructure, examples) in this project mbt-bundle. Please set the right labels for each issue.

Write bug reports with detail, background, and sample code

You can use this example

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Additional details / screenshot (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

We use both of these coding standards:

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

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