File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ How to contribute
2+ =================
3+
4+ .. code-block :: bash
5+ git clone git@github.com:kelsoncm/sc4.git ~ /projetos/PESSOAL/sc4py
6+ code ~ /projetos/PESSOAL/sc4py
7+
8+ Pre-commit
9+ ----------
10+
11+ This repository uses [pre-commit](https://pre-commit.com/) to run quality checks
12+ before each commit and coverage regression checks before each push.
13+
14+ **Setup: **
15+
16+ .. code-block :: bash
17+ python -m venv .venv
18+ .venv\b in\a ctivate
19+ .\. venv\S cripts\A ctivate.ps1
20+ pip install --upgrade pip uv
21+ uv pip install --upgrade -e " .[dev]"
22+ pre-commit install
23+ pre-commit install --hook-type pre-push
24+
25+ Run manually:
26+
27+ .. code-block :: bash
28+ pre-commit run --all-files
29+ pre-commit run --hook-stage pre-push --all-files
30+
31+ **Hooks: **
32+
33+ * **pre-commit **
34+ * `trailing-whitespace ` for eliminating trailing whitespace
35+ * `end-of-file-fixer ` for ensuring files end with a newline
36+ * `check-yaml ` for validating YAML files
37+ * `check-added-large-files ` for preventing large files from being committed
38+ * `black ` for code formatting
39+ * `ruff ` for linting and static analysis
40+ * `doc8 ` for checking documentation style
41+ * `markdownlint ` for checking Markdown style
42+ * **pre-push **:
43+ * `pytest ` for running tests
44+ * `pytest-coverage-gate ` for checking test coverage
45+ * **GitHub Actions only **
46+ * `semgrep ` for security and code quality checks
Original file line number Diff line number Diff line change @@ -116,3 +116,4 @@ Next steps
116116 api-readers
117117 api-renders
118118 api-hydrating
119+ contribute
You can’t perform that action at this time.
0 commit comments