Skip to content

Commit 084fda0

Browse files
authored
Add CONTRIBUTING.md (#85)
1 parent 1eca619 commit 084fda0

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to BackendBench
2+
3+
## License
4+
5+
BackendBench is BSD-3-Clause licensed, as found in the LICENSE file.
6+
7+
## Our Development Process
8+
9+
BackendBench is actively developed internally at Meta and synced to GitHub regularly. External contributions are welcomed and will be reviewed by the Meta team.
10+
11+
## Code Quality
12+
13+
We use [ruff](https://docs.astral.sh/ruff/) for linting and code formatting.
14+
15+
## Pre-commit Hooks
16+
17+
To make development easier, we provide pre-commit hooks that automatically run ruff on your changes:
18+
19+
```bash
20+
pip install pre-commit
21+
pre-commit install
22+
```
23+
24+
This will automatically lint your code before each commit, ensuring consistent code quality across the project.
25+
26+
## Pull Requests
27+
28+
We actively welcome your pull requests.
29+
30+
1. Fork the repo and create your branch from `main`.
31+
2. If you've added code that should be tested, add tests.
32+
3. If you've changed APIs, update the documentation.
33+
4. Ensure the test suite passes.
34+
5. Make sure your code lints.
35+
6. If you haven't already, complete the Contributor License Agreement ("CLA").
36+
37+
## Contributor License Agreement ("CLA")
38+
39+
In order to accept your pull request, we need you to submit a CLA. You only need
40+
to do this once to work on any of Meta's open source projects.
41+
42+
Complete your CLA here: <https://code.facebook.com/cla>
43+
44+
## Issues
45+
46+
We use GitHub issues to track public bugs. Please ensure your description is
47+
clear and has sufficient instructions to be able to reproduce the issue.

0 commit comments

Comments
 (0)