diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f2b5e09d..832e1f53 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -49,7 +49,7 @@ Checklist --------- - + - [ ] My code follows the code style of this project (Mypy, Ruff) - [ ] I have added tests to cover my changes diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 00000000..27c3b3b4 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,29 @@ +# Governance + +FastAPI Guard is part of the [Guard Core](https://github.com/Guard-Core) ecosystem. I maintain it alone; [MAINTAINERS.md](MAINTAINERS.md) lists who I am and how to check it. + +## Decisions + +I make the final call on every change: features, releases, security fixes and repository access. A proposal starts as an issue, so the reasoning is public before any code is written. + +## How a change lands + +1. Every change is a pull request to `master`. +2. The branch ruleset requires signed commits, linear history, passing status checks and two approvals, one of them from a code owner ([CODEOWNERS](CODEOWNERS)). As the only maintainer I cannot get those approvals, so I merge my own pull requests with admin rights. That skips the approval count only: I never merge with a failing check. +3. A pull request closes an open issue (`Closes #N`), or carries the `no-issue` label when it is a small fix with nothing to discuss. + +## Releases + +Versions follow semantic versioning. Adapters version on their own, because each one follows its framework, and declare the engine versions they support. Releases are cut from tags and recorded in [CHANGELOG.md](CHANGELOG.md). + +## Security + +Vulnerabilities go through [SECURITY.md](SECURITY.md), never through public issues. + +## New maintainers + +Contributors with a record of reviewed and merged work can be invited as maintainers. A new maintainer is added to MAINTAINERS.md and CODEOWNERS in a pull request. + +## Conduct + +The [Code of Conduct](CODE_OF_CONDUCT.md) applies to every space of this project. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..a0d87002 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,21 @@ +# Maintainers + +FastAPI Guard has one maintainer. + +| Name | GitHub | Email | Role | +|---|---|---|---| +| Renzo Franceschini | [@rennf93](https://github.com/rennf93) | rennf93@guard-core.com | Lead maintainer: reviews and merges every change, publishes every release, handles security reports | + +## Identity + +- GitHub profile [@rennf93](https://github.com/rennf93): name Renzo Franceschini, website guard-core.com. +- [guard-core.com/company](https://guard-core.com/company) names Renzo Franceschini and links to @rennf93. +- The [Guard-Core](https://github.com/Guard-Core) GitHub organization has guard-core.com as a verified domain. +- PyPI: the [fastapi-guard](https://pypi.org/project/fastapi-guard/) metadata names `Renzo Franceschini `. + +## Related files + +- Code ownership: [CODEOWNERS](CODEOWNERS) +- How decisions are made: [GOVERNANCE.md](GOVERNANCE.md) +- Security reports: [SECURITY.md](SECURITY.md) +- Getting help: [SUPPORT.md](SUPPORT.md) diff --git a/SECURITY.md b/SECURITY.md index 72dec29b..f9bb3812 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,19 +2,19 @@ ## Supported Versions -We currently provide security updates for the following versions of FastAPI Guard: +I provide security updates for the following versions of FastAPI Guard: -| Version | Supported | -| ------- | ------------------ | -| 5.0.x | :white_check_mark: | -| 4.x.x | :white_check_mark: | -| < 4.0 | :x: | +| Version | Supported | +| ------- | --------- | +| 8.x | :white_check_mark: bug and security fixes | +| 7.x | :white_check_mark: security fixes only | +| < 7.0 | :x: | ## Reporting a Vulnerability -We take the security of FastAPI Guard seriously. If you believe you've found a security vulnerability, please follow these steps: +I take the security of FastAPI Guard seriously. If you believe you've found a security vulnerability, please follow these steps: -1. **Do not disclose the vulnerability publicly** until it has been addressed by the maintainers. +1. **Do not disclose the vulnerability publicly** until I have fixed it. 2. **Report the vulnerability through GitHub's security advisory feature**: - Go to the [Security tab](https://github.com/Guard-Core/fastapi-guard/security/advisories) of the FastAPI Guard repository - Click on "New draft security advisory" @@ -29,7 +29,7 @@ We take the security of FastAPI Guard seriously. If you believe you've found a s - Affected versions - Any potential mitigations or workarounds -The maintainers will acknowledge your report within 48 hours and provide a detailed response within 7 days, including the next steps in handling the vulnerability. +I will acknowledge your report within 48 hours and send a detailed response within 7 days, including the next steps in handling the vulnerability. ## Security Best Practices @@ -99,16 +99,16 @@ Note that FastAPI Guard is a defense-in-depth measure and should be used alongsi ## Security Updates -Security updates will be released as needed. We recommend subscribing to GitHub releases or regularly checking for updates to ensure you're using the most secure version. +Security updates will be released as needed. I recommend subscribing to GitHub releases or regularly checking for updates to ensure you're using the most secure version. ## Responsible Disclosure -We follow responsible disclosure principles. If you report a vulnerability to us: +I follow responsible disclosure principles. If you report a vulnerability to me: -1. We will confirm receipt of your vulnerability report -2. We will provide an estimated timeline for a fix -3. We will notify you when the vulnerability is fixed -4. We will publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous) +1. I will confirm receipt of your vulnerability report +2. I will provide an estimated timeline for a fix +3. I will notify you when the vulnerability is fixed +4. I will publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous) ## License diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..82214684 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,8 @@ +# Support + +- Documentation: [https://guard-core.github.io/fastapi-guard/](https://guard-core.github.io/fastapi-guard/) +- Questions: [GitHub Discussions](https://github.com/Guard-Core/fastapi-guard/discussions) +- Chat: [Discord](https://discord.gg/ZW7ZJbjMkK), #help for questions, #releases for new versions. +- Bugs and feature requests: [issues](https://github.com/Guard-Core/fastapi-guard/issues/new/choose), using the templates. +- Security reports: [SECURITY.md](SECURITY.md), never a public issue. +- The hosted Guard Core app (app.guard-core.com): [saas-issues](https://github.com/Guard-Core/saas-issues).