Files

fvonhoven decde229b6 Update README w/TOC & link Contributing & MIT sections (#222 )

Summary:
* Add a Table of Contents to README
* Link CONTRIBUTING section to CONTRIBUTING.md file
* Link License section to LICENSE file
* Change `Sonar` references to `Flipper` in CONTRIBUTING.md

![flipper-readme](https://user-images.githubusercontent.com/10098988/43982318-f201c870-9cba-11e8-90b7-ebc47854e641.gif)
Pull Request resolved: https://github.com/facebook/flipper/pull/222

Reviewed By: danielbuechele

Differential Revision: D9282868

Pulled By: passy

fbshipit-source-id: 2f1ff9b598b8a0afdde9039e5a2c4a157c48ed9c

2018-08-13 03:42:30 -07:00

1.9 KiB

Raw Blame History

Contributing to Flipper

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

Our Development Process

Changes from Facebook employees are synced to the GitHub repo automatically. PRs from the community are imported into our internal source control and then pushed to GitHub.

For changes affecting both, native code and JavaScript, make sure to only create a single PR containing both parts of the code.

Although the Flipper desktop app is only released for macOS right now, it is possible to create Windows and Linux builds of the app. Please keep this in mind when dealing with platform-specific code.

Pull Requests

We actively welcome your pull requests.

Fork the repo and create your branch from master.
If you've added code that should be tested, add tests.
If you've changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.
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

We are using Prettier to format our source code. The styles are enforced via eslint. Make sure everything is well formatted before creating a PR. Therefore, run yarn lint and yarn fix to apply formatting fixes.

License

By contributing to Flipper, you agree that your contributions will be licensed under the LICENSE file.

1.9 KiB Raw Blame History