Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.64 KB

Contributing to gatsbyan

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

  • Reporting a issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. 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 some tests' example.
  3. If you've changed APIs, update the documentation.
  4. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit 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.

Bug Reports

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Share the snapshot, if possible.
  • What actually happens
  • What you expected would happen
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People thorough bug reports. I'm not even kidding.

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary
  • What & why you wanted to add the specific feature
  • Additional Context like images, links to resources to implement the feature etc etc.

License

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