49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
|
# Contributing to jscodeshift
|
||
|
|
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`](CODE_OF_CONDUCT.md)
|
||
|
|
|
||
|
|
## Our Development Process
|
||
|
|
The majority of development on jscodeshift will occur through GitHub. Accordingly,
|
||
|
|
the process for contributing will follow standard GitHub protocol.
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
We actively welcome your pull requests.
|
||
|
|
|
||
|
|
1. Fork the repo and create your branch from `main`.
|
||
|
|
1. Run `corepack enable` to set up `yarn` package manager.
|
||
|
|
1. If you've added code that should be tested, add tests.
|
||
|
|
1. If you've changed APIs, update the documentation.
|
||
|
|
1. Ensure the test suite passes.
|
||
|
|
1. Make sure your code lints.
|
||
|
|
1. 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 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](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
|
||
|
|
* Use semicolons;
|
||
|
|
* Commas last,
|
||
|
|
* 2 spaces for indentation (no tabs)
|
||
|
|
* Prefer `'` over `"`
|
||
|
|
* `'use strict';`
|
||
|
|
* 80 character line length
|
||
|
|
* "Attractive"
|
||
|
|
|
||
|
|
### License
|
||
|
|
|
||
|
|
jscodeshift is [MIT licensed](./LICENSE).
|