Skip to content

Commit a252d2e

Browse files
authored
📝 Add CONTRIBUTING.md (#2159)
1 parent fa87951 commit a252d2e

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the Full Stack FastAPI Template! 🙇
4+
5+
## Discussions First
6+
7+
For **big changes** (new features, architectural changes, significant refactoring), please start by opening a [GitHub Discussion](https://github.com/fastapi/full-stack-fastapi-template/discussions) first. This allows the community and maintainers to provide feedback on the approach before you invest significant time in implementation.
8+
9+
For small, straightforward changes, you can go directly to a Pull Request without starting a discussion first. This includes:
10+
11+
- Typos and grammatical fixes
12+
- Small reproducible bug fixes
13+
- Fixing lint warnings or type errors
14+
- Minor code improvements (e.g., removing unused code)
15+
16+
## Developing
17+
18+
For detailed instructions on setting up your development environment, running the stack, linting, pre-commit hooks, and more, see the [Development Guide](development.md).
19+
20+
## Pull Requests
21+
22+
When submitting a pull request:
23+
24+
1. Make sure all tests pass before submitting.
25+
2. Keep PRs focused on a single change.
26+
3. Update tests if you're changing functionality.
27+
4. Reference any related issues in your PR description.
28+
29+
## Automated Code and AI
30+
31+
You are encouraged to use all the tools you want to do your work and contribute as efficiently as possible, this includes AI (LLM) tools, etc. Nevertheless, contributions should have meaningful human intervention, judgement, context, etc.
32+
33+
If the **human effort** put in a PR, e.g. writing LLM prompts, is **less** than the **effort we would need to put** to **review it**, please **don't** submit the PR.
34+
35+
Think of it this way: we can already write LLM prompts or run automated tools ourselves, and that would be faster than reviewing external PRs.
36+
37+
### Closing Automated and AI PRs
38+
39+
If we see PRs that seem AI generated or automated in similar ways, we'll flag them and close them.
40+
41+
The same applies to comments and descriptions, please don't copy paste the content generated by an LLM.
42+
43+
### Human Effort Denial of Service
44+
45+
Using automated tools and AI to submit PRs or comments that we have to carefully review and handle would be the equivalent of a [Denial-of-service attack](https://en.wikipedia.org/wiki/Denial-of-service_attack) on our human effort.
46+
47+
It would be very little effort from the person submitting the PR (an LLM prompt) that generates a large amount of effort on our side (carefully reviewing code).
48+
49+
Please don't do that.
50+
51+
We'll need to block accounts that spam us with repeated automated PRs or comments.
52+
53+
### Use Tools Wisely
54+
55+
As Uncle Ben said:
56+
57+
> With great ~~power~~ **tools** comes great responsibility.
58+
59+
Avoid inadvertently doing harm.
60+
61+
You have amazing tools at hand, use them wisely to help effectively.
62+
63+
## Questions?
64+
65+
If you have questions about contributing, feel free to open a [GitHub Discussion](https://github.com/fastapi/full-stack-fastapi-template/discussions).

0 commit comments

Comments
 (0)