Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 2.23 KB
Raw

Contributing to yoga

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

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.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation.
  4. Format the repository with yarn format.
  5. Ensure the test suite passes and yarn lint succeeds.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Yoga is also included in React Native. Add a Changelog: entry to your pull request description so user-visible Yoga changes can appear in React Native release notes. For example:

Changelog:
[General][Fixed] - Fix Yoga flex shrink producing oversized items when all children reach their minimum sizes

Use Changelog: [Internal] only for changes that do not affect users, such as tests or documentation. See the React Native changelog guidelines for the available categories and types.

yarn format-check checks all maintained JavaScript and documentation, C-family, Kotlin, and Python sources without modifying them. Running all formatters requires Node and Yarn, Java 17 or newer, and Python 3 with pip.

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.

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.

License

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