# Contributing to the NPE Toolkit
We want to make contributing to this project as easy and transparent as possible.

## Pull Requests
We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
2. [Integration tests](https://app.circleci.com/pipelines/github/facebookincubator/npe-toolkit) should automatically run when you create your PR.
3. Additionally, we use consistent formatting across the repo via Prettier. You can format your project by running `tools/project/prettify.sh`.
4. If you haven't already, complete the Contributor License Agreement ("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 to work on any of Meta'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.

Meta has a [bounty program](https://www.facebook.com/whitehat/) 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.

## Coding Style
We have eslint rules set up that should be used to autoformat files before submission. This works best if you have your IDE set up to autoformat on save, but you can also run`tools/project/prettify.sh`.

## License
By contributing to the NPE Toolkit, you agree that your contributions will be licensed
under the [LICENSE](LICENSE) file in the root directory of this source tree.