Skip to content

Commit ddbcf51

Browse files
committed
docs: add CONTRIBUTING.md and CODE_OF_CONDUCT.md
Add community guidelines for the public repository: - CONTRIBUTING.md with dev setup, testing, and PR guidelines - CODE_OF_CONDUCT.md based on Contributor Covenant 2.1
1 parent a74e43a commit ddbcf51

2 files changed

Lines changed: 120 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment:
15+
16+
- Using welcoming and inclusive language
17+
- Being respectful of differing viewpoints and experiences
18+
- Gracefully accepting constructive criticism
19+
- Focusing on what is best for the community
20+
- Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior:
23+
24+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
25+
- Trolling, insulting or derogatory comments, and personal or political attacks
26+
- Public or private harassment
27+
- Publishing others' private information without their explicit permission
28+
- Other conduct which could reasonably be considered inappropriate in a professional setting
29+
30+
## Enforcement Responsibilities
31+
32+
Project maintainers are responsible for clarifying and enforcing our standards of
33+
acceptable behavior and will take appropriate and fair corrective action in
34+
response to any behavior that they deem inappropriate, threatening, offensive,
35+
or harmful.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, and also applies when
40+
an individual is officially representing the community in public spaces.
41+
42+
## Enforcement
43+
44+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
45+
reported to the project team at **[email protected]**.
46+
47+
All complaints will be reviewed and investigated promptly and fairly.
48+
49+
## Attribution
50+
51+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
52+
version 2.1, available at
53+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing to Vigil Guard Python SDK
2+
3+
Thank you for your interest in contributing to the Vigil Guard Python SDK.
4+
5+
## Getting Started
6+
7+
### Development Setup
8+
9+
```bash
10+
git clone https://github.com/Vigil-Guard/python-SDK-vge.git
11+
cd python-SDK-vge
12+
python -m venv .venv
13+
source .venv/bin/activate
14+
pip install -e ".[dev]"
15+
```
16+
17+
### Running Tests
18+
19+
```bash
20+
pytest -m "not integration and not performance" -v
21+
```
22+
23+
### Linting and Type Checking
24+
25+
```bash
26+
ruff check src/vigil/ tests/
27+
mypy --strict src/vigil/
28+
```
29+
30+
## How to Contribute
31+
32+
### Reporting Bugs
33+
34+
Open a [GitHub issue](https://github.com/Vigil-Guard/python-SDK-vge/issues) with:
35+
36+
- Python version and OS
37+
- SDK version (`pip show vigil-guard`)
38+
- Minimal reproduction steps
39+
- Expected vs actual behavior
40+
41+
For security vulnerabilities, see [SECURITY.md](SECURITY.md).
42+
43+
### Submitting Changes
44+
45+
1. Fork the repository
46+
2. Create a feature branch (`git checkout -b feature/your-feature`)
47+
3. Write tests for your changes
48+
4. Ensure all tests pass and linters are clean
49+
5. Submit a pull request against `main`
50+
51+
### Pull Request Guidelines
52+
53+
- Keep changes focused — one feature or fix per PR
54+
- Add or update tests (target 80%+ coverage for new code)
55+
- Follow existing code style (enforced by ruff and mypy)
56+
- Update CHANGELOG.md under `[Unreleased]`
57+
58+
## Code Style
59+
60+
- Python 3.9+ compatible syntax
61+
- Type hints on all public APIs (mypy strict mode)
62+
- ruff for linting and formatting
63+
- 100 character line length
64+
65+
## License
66+
67+
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)