Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 2.79 KB
Raw

Contributing to F8 App

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

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md

Get involved

There are many ways to contribute to this project, and many of them do not involve writing any code. Here's a few ideas to get started:

  • Go through the Getting Started guide to insall and use the app. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
  • Look through the open issues. Provide workarounds, ask for clarification, or suggest labels.
  • If you find an issue you would like to fix, add a comment stating your intent to tackle it. Then open a pull request with your changes. Issues tagged as good first issue are a good place to get started.

Pull Request Workflow

Before submitting a pull request, please make sure the following is done…

  1. Fork the repo and create your branch from master. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/

    Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:

    git clone https://github.com/<your_username>/f8app
cd f8app
git checkout -b my_branch

    Note: Replace <your_username> with your GitHub username

  2. Follow the setup instructions to run the app and test your changes.

  3. If you haven't already, complete the Contributor License Agreement ("CLA").

After opening your pull request, ensure all tests pass on Circle CI. Pull requests that break tests are unlikely to be merged. If a test fails and you believe it is unrelated to your change, leave a comment on the pull request explaining why.

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.

Security Bugs

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.

Code Conventions

  • ES6 syntax when possible.
  • Use Flow types.
  • Avd abbr wrds.

License

By contributing to this repo, you agree that your contributions will be licensed under its license.