flow / flow-bin

Binary wrapper for Flow - A static type checker for JavaScript
https://flow.org
Other
535 stars 47 forks source link

Update readme.md #187

Closed Rohit24567 closed 9 months ago

Rohit24567 commented 11 months ago

The current readme in the main branch of this project is very vague and has little description. The current description is just how to download Flow-Bin, as well as the API, license, and releases. I believe that adding a brief description before these groups would heavily benefit this project. One advantage of having a description is that it allows users to understand the project that they are downloading rather than just trying to learn on the go. Another advantage is that a description could let users read about how they can implement this program into their own code, saving them time.

facebook-github-bot commented 11 months ago

Hi @Rohit24567!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!