Skip to content

Commit 4af1c00

Browse files
committed
chore: centralize org contribution and security templates
1 parent ed7caf6 commit 4af1c00

3 files changed

Lines changed: 74 additions & 105 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,49 @@
11
# Contributing to SQLoot
22

3-
Thank you for your interest in contributing! This document provides guidelines for contributing to SQLoot projects.
3+
Thanks for contributing.
44

5-
## Getting Started
5+
## Workflow
66

7-
1. Fork the repository
8-
2. Clone your fork
9-
3. Create a feature branch: `git checkout -b feat/your-feature`
10-
4. Make your changes
11-
5. Submit a pull request
7+
1. Create a feature branch from `main`
8+
2. Implement focused, reviewable changes
9+
3. Run local checks
10+
4. Open a PR and request review
1211

13-
## Development Setup
12+
## Local Checks
1413

15-
### Prerequisites
16-
17-
- [Bun](https://bun.sh) (latest)
18-
- Git
19-
20-
### Install dependencies
14+
Use the repository's standard verification command (typically one of):
2115

2216
```bash
23-
bun install
17+
bun verify
18+
bun run verify
2419
```
2520

26-
### Run quality checks
21+
If the repository includes Rust code, also run:
2722

2823
```bash
29-
bun run check
24+
cargo fmt --all
25+
cargo test
3026
```
3127

32-
## Code Style
33-
34-
We use **Biome** for linting and formatting. Configuration is in `biome.json`.
28+
## Engineering Standards
3529

36-
```bash
37-
# Format code
38-
bun run format
39-
40-
# Lint code
41-
bun run lint
42-
```
30+
- Prefer Bun tooling over npm/pnpm
31+
- Prefer Biome for formatting/linting where configured
32+
- Keep TypeScript strict and avoid `any` unless justified
33+
- Add/update tests for behavior changes
34+
- Update docs when behavior or public API changes
4335

44-
## Commit Messages
36+
## Pull Requests
4537

46-
Use clear, descriptive commit messages:
38+
- Keep PR scope small and explicit
39+
- Link related issue(s)
40+
- Document any breaking change
41+
- Resolve all review comments before merge
4742

48-
- `feat: add user authentication`
49-
- `fix: resolve memory leak in sync`
50-
- `docs: update API documentation`
51-
- `refactor: simplify data layer`
43+
## Security
5244

53-
## Pull Request Process
54-
55-
1. Ensure all checks pass
56-
2. Update documentation if needed
57-
3. Request review from maintainers
58-
4. Address feedback
45+
For vulnerabilities, do not use public issues. Follow `SECURITY.md`.
5946

6047
## Code of Conduct
6148

62-
Please read our [Code of Conduct](CODE_OF_CONDUCT.md).
63-
64-
## Questions?
65-
66-
Open a discussion or reach out via issues.
67-
68-
---
69-
70-
<div align="center">
71-
<a href="https://github.com/enterprises/ownCTRL"><img src="https://img.shields.io/badge/©️_2026-ownCTRL™-333?style=flat&labelColor=ddd" alt="© 2026 ownCTRL™"/></a>
72-
<a href="https://github.com/miccy"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40miccy-333?style=flat&labelColor=ddd" alt="Maintained by @miccy"/></a>
73-
</div>
49+
See `CODE_OF_CONDUCT.md`.

PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
## Description
1+
## Summary
22

3-
<!-- Brief description of changes -->
3+
<!-- What changed and why -->
44

5-
## Type of Change
5+
## Scope
66

77
- [ ] Bug fix
8-
- [ ] New feature
8+
- [ ] Feature
9+
- [ ] Refactor
10+
- [ ] Docs
11+
- [ ] CI/Tooling
912
- [ ] Breaking change
10-
- [ ] Documentation update
11-
- [ ] Refactoring
1213

13-
## Checklist
14+
## Verification
1415

15-
- [ ] Code follows project style guidelines
16-
- [ ] Tests pass locally (`bun run check`)
17-
- [ ] Documentation updated (if applicable)
18-
- [ ] No secrets or sensitive data included
16+
- [ ] I ran the repository verification command successfully (`bun verify` or repo equivalent)
17+
- [ ] I added/updated tests where needed
18+
- [ ] I updated docs where needed
1919

20-
## Related Issues
20+
## Governance
2121

22-
<!-- Link any related issues: Fixes #123 -->
22+
- [ ] No secrets or credentials introduced
23+
- [ ] CODEOWNERS-relevant changes requested proper reviewers
24+
25+
## Linked Issues
26+
27+
<!-- Fixes #123 -->

SECURITY.md

Lines changed: 29 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,46 @@
22

33
## Reporting a Vulnerability
44

5-
We take security seriously. If you discover a security vulnerability, please report it responsibly.
5+
Please report security vulnerabilities privately.
66

7-
### How to Report
7+
1. Do **not** open a public issue.
8+
2. Use GitHub Private Vulnerability Reporting in the affected repository (`Security` tab).
9+
3. If needed, contact us at **security@sqloot.dev**.
810

9-
1. **DO NOT** create a public GitHub issue
10-
2. **Preferred**: Use [GitHub's private vulnerability reporting](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability) on the affected repository's Security tab
11-
3. **Alternative**: Email: security@sqloot.dev
12-
4. Include:
13-
- Description of the vulnerability
14-
- Steps to reproduce
15-
- Potential impact
16-
- Any suggested fixes (optional)
11+
Please include:
12+
- Affected repository/package and version/commit
13+
- Reproduction steps or PoC
14+
- Impact assessment
15+
- Suggested mitigation (optional)
1716

18-
### What to Expect
17+
## Response Targets
1918

20-
- **Acknowledgment**: Within 48 hours
21-
- **Initial assessment**: Within 7 days
22-
- **Resolution timeline**: Depends on severity (critical: ASAP, high: 30 days, medium: 90 days)
19+
- Acknowledgement: within 48 hours
20+
- Initial triage: within 7 days
21+
- Fix timeline:
22+
- Critical: as soon as possible
23+
- High: target within 30 days
24+
- Medium: target within 90 days
2325

24-
### Scope
26+
## Scope
2527

26-
This policy applies to all SQLoot repositories.
27-
28-
### Recognition
29-
30-
We appreciate responsible disclosure and will acknowledge security researchers in our release notes (unless you prefer to remain anonymous).
28+
This policy applies to all repositories under the SQLoot organization.
3129

3230
## Supported Versions
3331

34-
| Version | Supported |
35-
| -------- | ----------------------- |
36-
| Latest ||
37-
| < Latest | ❌ (upgrade recommended) |
38-
39-
## Security Best Practices
32+
| Version line | Supported |
33+
| --- | --- |
34+
| Current main/default branch ||
35+
| Older versions ||
4036

41-
When contributing to SQLoot projects:
37+
## Contributor Security Requirements
4238

43-
- Never commit secrets, API keys, or credentials
44-
- Use environment variables for sensitive data
45-
- Keep dependencies up to date
46-
- Follow secure coding practices
39+
- Never commit secrets or credentials
40+
- Minimize sensitive logging
41+
- Keep dependencies updated
42+
- Use least-privilege tokens and permissions
4743
- Enable 2FA on your GitHub account
4844

49-
## Security.txt
50-
51-
For automated security tools, we follow [RFC 9116](https://www.rfc-editor.org/rfc/rfc9116.html).
52-
See `/.well-known/security.txt` in production deployments.
53-
54-
---
45+
## Coordinated Disclosure
5546

56-
<div align="center">
57-
<a href="https://github.com/enterprises/ownCTRL"><img src="https://img.shields.io/badge/©️_2026-ownCTRL™-333?style=flat&labelColor=ddd" alt="© 2026 ownCTRL™"/></a>
58-
<a href="https://github.com/miccy"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40miccy-333?style=flat&labelColor=ddd" alt="Maintained by @miccy"/></a>
59-
</div>
47+
We appreciate responsible disclosure and can credit reporters in release notes, unless anonymity is requested.

0 commit comments

Comments
 (0)