search

facebookarchive / network-connection-class

Listen to current network traffic in the app and categorize the quality of the network.
Other
3.19k stars 515 forks source link

Contribution page 'pull request' guidelines can be more clear and better formatted #15

Closed PrashantSunkari closed 9 years ago

PrashantSunkari commented 9 years ago

To sum up the bug a. There is room for Formatting improvement b. Point 4 "Make sure your code lints" makes lesser sense than "Make sure your code lints (grunt lint) - we've done our best to make sure these rules match our internal linting guidelines." (This test is from react project)

Currently, pull request guidelines looks like blob of text. "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. If you haven't already, complete the Contributor License Agreement ("CLA"). Link: https://github.com/facebook/network-connection-class/blob/master/CONTRIBUTING.md#pull-requests

I suggest we make it clearer and more neater like in react project eg: https://github.com/swannodette/react/blob/master/CONTRIBUTING.md#pull-requests

PrashantSunkari commented 9 years ago

I am working on this bug.

PrashantSunkari commented 9 years ago

Same as Issue 16. Closing this one.