Skip to content

Commit 52c60b8

Browse files
docs: add contributing and security policy documentation & improved release please configuration
1 parent bb826a2 commit 52c60b8

File tree

3 files changed

+87
-2
lines changed

3 files changed

+87
-2
lines changed

.release-please-config.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
"backend": {
44
"path": "backend",
55
"release-type": "python",
6-
"version-file": "backend/pyproject.toml"
6+
"version-file": "backend/pyproject.toml",
7+
"changelog-path": "backend/CHANGELOG.md",
8+
"skip-empty-release": true
79
},
810
"frontend": {
911
"path": "frontend",
1012
"release-type": "node",
11-
"version-file": "frontend/package.json"
13+
"version-file": "frontend/package.json",
14+
"changelog-path": "frontend/CHANGELOG.md",
15+
"skip-empty-release": true
1216
}
1317
}
1418
}

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to GAIA
2+
3+
GAIA is an open source project, and we welcome contributions of all kinds:
4+
5+
- Code patches
6+
- Documentation improvements
7+
- Bug reports and reviews
8+
- Tests and code quality enhancements
9+
10+
## Getting Started
11+
12+
- Read our [Code of Conduct](https://github.com/heygaia/gaia/blob/master/CODE_OF_CONDUCT.md)
13+
- Set up your environment: [Development Setup Guide](https://docs.heygaia.io/developers/development-setup)
14+
- Explore our [contribution guidelines](https://docs.heygaia.io/developers/contributing) for details
15+
16+
## How to Contribute
17+
18+
- Bug fixes, features, docs, and tests are all welcome ([see ways to contribute](https://docs.heygaia.io/developers/contributing#ways-to-contribute))
19+
- Fork the repo, create a branch, make changes, test, and open a pull request ([workflow details](https://docs.heygaia.io/developers/contributing#contribution-workflow))
20+
- Follow our [coding standards](https://docs.heygaia.io/developers/contributing#coding-standards) for Python and React/Next.js
21+
- Use [Conventional Commits](https://docs.heygaia.io/developers/contributing#commit-message-guidelines) for commit messages
22+
23+
## Pull Requests
24+
25+
- Ensure code style, tests, and docs are up to date
26+
- Use the [PR template](https://docs.heygaia.io/developers/contributing#pr-description-template)
27+
- No merge conflicts with `master` branch
28+
29+
## Code of Conduct
30+
31+
Help us keep GAIA open and inclusive. Please read and follow our [Code of Conduct](https://github.com/heygaia/gaia/blob/master/CODE_OF_CONDUCT.md).
32+
33+
## Need Help?
34+
35+
- [Documentation](https://docs.heygaia.io/)
36+
- [Discord Community](https://discord.heygaia.io/)
37+
- [GitHub Issues](https://github.com/heygaia/gaia/issues)
38+
- [Discussions](https://github.com/heygaia/gaia/discussions)
39+
40+
Thank you for contributing to GAIA!

SECURITY.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security issue in this project, please report it responsibly:
6+
7+
- **Do not open a public GitHub issue.**
8+
- Instead, email us at **security@heygaia.io**.
9+
- Please include:
10+
- A clear description of the vulnerability
11+
- Steps to reproduce (if available)
12+
- Any proof-of-concept code or details
13+
14+
We will acknowledge your report within **48 hours** and keep you informed as we investigate and fix the issue.
15+
16+
---
17+
18+
## Disclosure Policy
19+
20+
- We follow a **coordinated disclosure process**.
21+
- Once a fix is ready, we will:
22+
- Release a patch
23+
- Update documentation if necessary
24+
- Credit the reporter (unless you prefer otherwise)
25+
26+
---
27+
28+
## Supported Versions
29+
30+
We currently support security updates for the following versions:
31+
32+
| Version | Supported |
33+
| ------- | --------- |
34+
| latest ||
35+
| older ||
36+
37+
---
38+
39+
## Preferred Languages
40+
41+
We prefer vulnerability reports in **English**, but will make reasonable efforts to work with any reporter.

0 commit comments

Comments
 (0)