jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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
This commit is contained in:
fvonhoven
2018-08-13 03:38:39 -07:00
committed by Facebook Github Bot
parent 4ae01fce6a
commit decde229b6
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -1,4 +1,4 @@
# Contributing to Sonar
# Contributing to Flipper
We want to make contributing to this project as easy and transparent as
possible.
@@ -12,7 +12,7 @@ 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 Sonar desktop app is only released for macOS right now, it is
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.
@@ -51,5 +51,5 @@ run `yarn lint` and `yarn fix` to apply formatting fixes.
## License
By contributing to Sonar, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.
By contributing to Flipper, you agree that your contributions will be licensed
under the [LICENSE](./LICENSE) file.