Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

83 lines (52 loc) · 3.98 KB
Raw

Contributing to Metro

Metro is one of Facebook's open source projects that is both under very active development and is also being used to ship code to everybody on facebook.com. We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Our Development Process

The core team works directly on GitHub and all work is public.

main is unsafe

We will do our best to keep main in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We will do our best to communicate these changes and always version appropriately so you can lock into a specific version if need be.

Workflow and Pull Requests

The core team will be monitoring for pull requests. When we get one, we'll run some Facebook-specific integration tests on it first. From here, we'll need to get another person to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.

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

  1. Fork the repo and create your branch from main.

    git clone https://github.com/facebook/metro
cd metro
git checkout -b my_branch

  2. Run yarn.

    yarn

  3. Code in this repo is typechecked with Flow. [Optional] If you are using VS Code, we recommend opening the metro.code-workspace file, which should configure the Flow Language Service and other workspace settings correctly.

  4. If you've added code that should be tested, add tests.

  5. If you've changed APIs:

    1. Update the documentation if necessary.
    2. Update any relevant .d.ts files under the package's types/ directory.

  6. Ensure the test suite passes via npm test.

  7. If you haven't already, complete the 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, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.

Complete your CLA here.

Bugs

Where to Find Known Issues

We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.

Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.

Security Bugs

Facebook has a bounty program for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page.

How to Get in Touch

Code Conventions

  • 2 spaces for indentation (no tabs).
  • 80 character line length strongly preferred.
  • Prefer ' over ".
  • ES2015 syntax when possible.
  • 'use strict';.
  • Use Flow types.
  • Use semicolons;
  • Trailing commas,
  • Avd abbr wrds.

License

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