Skip to content

Commit eb13baa

Browse files
DevMacdsantoreis
authored andcommitted
docs: expand trust signals to enterprise standard
Flesh out CONTRIBUTING.md with dev setup, PR format, and review guidelines. Add proper SECURITY.md with advisory links and disclosure policy. Expand CODE_OF_CONDUCT.md based on Contributor Covenant v2.1. Improve issue templates with structured fields. Co-authored-by: Daniel <dsantoreis@gmail.com>
1 parent a1d27ed commit eb13baa

5 files changed

Lines changed: 137 additions & 13 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,27 @@ about: Report a reproducible bug
44
labels: bug
55
---
66

7-
## Summary
7+
## What happened
8+
9+
A clear description of what went wrong.
810

911
## Steps to reproduce
1012

13+
1. ...
14+
2. ...
15+
3. ...
16+
1117
## Expected behavior
1218

13-
## Actual behavior
19+
What should have happened instead.
1420

1521
## Environment
22+
23+
- OS:
24+
- Python version:
25+
- Docker version (if applicable):
26+
- Browser (if frontend):
27+
28+
## Logs / Screenshots
29+
30+
Paste any relevant error output or screenshots.
Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
---
22
name: Feature request
3-
about: Propose a new capability
3+
about: Suggest an improvement
44
labels: enhancement
55
---
66

77
## Problem
88

9+
What problem does this solve? What's frustrating or missing today?
10+
911
## Proposed solution
12+
13+
How would you like it to work?
14+
15+
## Alternatives considered
16+
17+
Any other approaches you've thought about.
18+
19+
## Additional context
20+
21+
Screenshots, links, or examples from other projects.

CODE_OF_CONDUCT.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
11
# Code of Conduct
22

3-
Be respectful, constructive, and professional.
4-
Harassment and personal attacks are not tolerated.
3+
## Our Standards
4+
5+
We're committed to providing a welcoming, inclusive environment for everyone. Examples of behavior that contributes to a positive environment:
6+
7+
- Using welcoming and inclusive language
8+
- Being respectful of differing viewpoints and experiences
9+
- Gracefully accepting constructive criticism
10+
- Focusing on what is best for the community
11+
12+
Examples of unacceptable behavior:
13+
14+
- Harassment, trolling, or personal attacks
15+
- Publishing others' private information without permission
16+
- Any conduct that would be considered inappropriate in a professional setting
17+
18+
## Enforcement
19+
20+
Project maintainers are responsible for clarifying standards of acceptable behavior and will take appropriate corrective action in response to unacceptable behavior.
21+
22+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting the maintainers directly. All complaints will be reviewed and investigated.
23+
24+
## Attribution
25+
26+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,61 @@
1-
# Contributing
1+
# Contributing to Askbase
22

3-
Thanks for contributing.
3+
Thanks for considering a contribution. Here's how to get started.
44

5-
1. Fork and create a branch
6-
2. Run tests and lint
7-
3. Open a PR with Problem, Root cause, Fix, Testing
5+
## Getting Started
6+
7+
1. Fork the repo and clone your fork
8+
2. Create a branch from `main` (`git checkout -b fix/your-change`)
9+
3. Install dependencies: `pip install -r requirements.txt` for the API, `npm install` in `frontend/`
10+
4. Run locally with `docker compose up --build -d`
11+
12+
## Making Changes
13+
14+
- Keep PRs focused on a single concern
15+
- Follow existing code style (black + ruff for Python, prettier for TypeScript)
16+
- Add or update tests for behavioral changes
17+
- Run the test suite before opening a PR
18+
19+
## PR Format
20+
21+
Structure your PR description:
22+
23+
```
24+
**Problem:** What was broken or missing
25+
**Root cause:** Why it was happening
26+
**Fix:** What you changed
27+
**Testing:** How you verified it works
28+
```
29+
30+
## Development Setup
31+
32+
```bash
33+
# Backend
34+
cd api
35+
python -m venv .venv && source .venv/bin/activate
36+
pip install -r requirements.txt
37+
pytest
38+
39+
# Frontend
40+
cd frontend
41+
npm install
42+
npm run dev
43+
44+
# Full stack
45+
docker compose up --build -d
46+
```
47+
48+
## Reporting Bugs
49+
50+
Open an issue with:
51+
- Steps to reproduce
52+
- Expected vs actual behavior
53+
- Environment details (OS, Python version, browser)
54+
55+
## Code Review
56+
57+
All submissions go through review. We look for correctness, test coverage, clean code, and no unnecessary complexity.
58+
59+
## License
60+
61+
By contributing, you agree that your contributions will be licensed under the MIT License.

SECURITY.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
# Security
1+
# Security Policy
22

3-
Report security issues privately to project maintainers.
4-
Do not open public issues for vulnerabilities before coordinated disclosure.
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| latest | Yes |
8+
9+
## Reporting a Vulnerability
10+
11+
**Do not open public issues for security vulnerabilities.**
12+
13+
Use [GitHub's private security advisory feature](https://github.com/dsantoreis/askbase/security/advisories/new) to report vulnerabilities confidentially.
14+
15+
Please include:
16+
- Description of the vulnerability
17+
- Steps to reproduce
18+
- Potential impact
19+
- Suggested fix (if you have one)
20+
21+
We aim to acknowledge reports within 48 hours and provide a timeline for resolution within 5 business days.
22+
23+
## Disclosure Policy
24+
25+
We follow coordinated disclosure. Once a fix is released, we'll publish a security advisory with credit to the reporter (unless they prefer to remain anonymous).

0 commit comments

Comments
 (0)