Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 2.38 KB

Contributing to Css Variables plugin

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

We Develop with Github

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

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 the pull request.

Any contributions you make will be Public Domain

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

Write bug reports with detail, background, and sample code

This is an example from Craig Hockenberry of a bug report.

Good 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 actions you performed that did not work)

People love thorough bug reports.

Use a Consistent Coding Style

Please, mind Facebook's Guidelines for an example.

License

By contributing, you agree that your contributions will be licensed under Public Domain license.

References

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