Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshowers authored Jan 8, 2023
1 parent f4abf83 commit 06ab82b
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Contributing to cargo-guppy

Development for `cargo-guppy` happens in the open on GitHub.

## Pull Requests

We actively welcome your pull requests. If you have a new feature in mind, please discuss the feature in an issue to
Expand All @@ -10,25 +8,17 @@ ensure that your contributions will be accepted.
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. Ensure the test suite passes with `cargo test --all-features`.
5. Run `cargo fmt` to automatically format your changes (CI will let you know if you missed this).
6. 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>
4. Ensure the test suite passes:
a. Install [cargo nextest](https://nexte.st/book/pre-built-binaries) if you haven't already.
b. Run `cargo nextest run --all-features`.
c. Run `cargo test --doc --all-features` to run doctests.
5. Run `cargo xfmt` to automatically format your changes (CI will let you know if you missed this).

## 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.

## License

By contributing to `cargo-guppy`, you agree that your contributions will be dual-licensed under the terms of the
Expand Down

0 comments on commit 06ab82b

Please sign in to comment.