Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 2.82 KB

Contributing to Project Errror

We love your input! We want to make contributing to our organization 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 or develop (if available).
  2. If you've changed APIs, update the documentation.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Semantic Versioning

Project Error follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.

Any contributions you make will be under the repository license

In short, when you submit code changes, your submissions are understood to be under the same CC-BY-NC-SA-4.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. Here's another example from Craig Hockenberry, a prominent app developer.

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

Consistent Code Styling

These guidelines have also been adapted from Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • Run yarn format for unification of styling across the project.

License

By contributing, you agree that your contributions will be licensed under the repository License.

References

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