Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 1.63 KB
Raw

Contributing to react-docgen

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

The majority of development on react-docgen will occur through GitHub. Accordingly, the process for contributing will follow standard GitHub protocol.

Pull Requests

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 and typechecks.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

  • Use semicolons;
  • Commas last,
  • 2 spaces for indentation (no tabs)
  • Prefer ' over "
  • "use strict";
  • 80 character line length
  • "Attractive"

License

react-docgen is MIT licensed.

By contributing to react-docgen, you agree that your contributions will be licensed under its MIT license.