Skip to content

Commit 292a802

Browse files
authored
Add contributing guidelines to CONTRIBUTING.md
This document provides guidelines for contributing to the SecSuite project, including setup instructions, common tasks, pre-commit hooks, and branching strategies.
1 parent e2d8a49 commit 292a802

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
Thank you for helping improve SecSuite! This short guide gets you up and running quickly.
4+
5+
Developer quick-start
6+
---------------------
7+
8+
1. Install `uv` (if you don't have it). Follow platform-specific instructions at https://docs.astral.sh/uv/.
9+
10+
2. Sync the development environment and install dev dependencies:
11+
12+
```bash
13+
make install
14+
```
15+
16+
3. Common tasks
17+
18+
- Run tests: `make test` or `./scripts/dev pytest`
19+
- Run lint: `make lint` or `./scripts/dev ruff check .`
20+
- Type check: `make type` or `./scripts/dev mypy src`
21+
- Build docs: `make docs` or `./scripts/dev sphinx-build -b html docs docs/_build`
22+
23+
Pre-commit
24+
----------
25+
26+
Install pre-commit hooks locally:
27+
28+
```bash
29+
make precommit
30+
```
31+
32+
Branching and PRs
33+
------------------
34+
35+
- Create a branch for your feature/fix: `git checkout -b feature/thing`
36+
- Run tests and linters locally before opening a PR.
37+
- Open a PR against `main` and include a short description of the change and why.
38+
39+
Thank you! Keep changes small and focused and include tests for new behavior.

0 commit comments

Comments
 (0)