Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 3.77 KB
Raw

Contributing to this repository

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

Getting started

Before you begin:

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 main.
  2. If you've changed APIs, update the documentation.
  3. Make changes according to your requirements
  4. 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!

Write bug reports with detail, background, and sample code

This is an example of a bug report. Here's another example from Craig Hockenberry, an 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.

Ready to make a change? Fork the repo

Make your update:

Make your changes to the file(s) you'd like to update in the forked repo.

  • Are you making changes to the application code? You'll need to check the dependancies.
  • Are you contributing to markdown? We use GitHub Markdown.

Open a pull request

When you're done making changes and you'd like to propose them for review, open your PR (pull request).

Submit your PR & get it reviewed

  • Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out our git tutorial on how to resolve merge conflicts and other issues.

Your PR is merged!

Congratulations! The whole GitHub community thanks you. ✨

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.

Use a Consistent Coding Style

I'm borrowing these from Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

License

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