From bd5dec2e0dc96fc842b1366be09c8a9774554669 Mon Sep 17 00:00:00 2001 From: edwdev-oficial Date: Sat, 21 Jun 2025 12:09:21 -0300 Subject: [PATCH] docs: add nox and lint instructions to CONTRIBUTING.md --- CONTRIBUTING.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b9452725..ae61b9db7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,28 @@ -Please read the [Development - Contributing](https://fastapi.tiangolo.com/contributing/) guidelines in the documentation site. +# Contributing to FastAPI + +Thank you for your interest in contributing! 🎉 + +Please refer to the complete guide at: +👉 [Development - Contributing](https://fastapi.tiangolo.com/contributing/) + +--- + +## Code Style and Formatting + +Before submitting a Pull Request, please make sure your code matches the project's style guidelines. + +### Install `nox` + +We use [nox](https://nox.thea.codes/) to run automated sessions like linters and formatters. + +Install it using pip: + +```bash +pip install nox +``` +Then, run the linting session with: + +```bash +nox -s lint +``` +This command runs the same checks used in the continuous integration (CI) process to ensure your code follows the style conventions of the project. \ No newline at end of file