Contributing
How to report a bug, request a change, or report a security issue, and why pull requests aren't accepted.
Thanks for your interest in RedScribe. This page mirrors CONTRIBUTING.md
in the repo root: here’s how you can help, and how you can’t.
What’s welcome
Section titled “What’s welcome”- Bug reports. Use the issue templates under
.github/ISSUE_TEMPLATE/. They ask for the information that’s actually useful for reproducing a problem in a self hosted Django app: version, install method, and whether it reproduces on a clean instance. - Feature requests / change requests. Same place, a separate template. Describe what you’d like to see and why. A maintainer will pick it up if it’s a good fit, on their own timeline.
What isn’t accepted
Section titled “What isn’t accepted”Pull requests aren’t accepted. Every code change to RedScribe, fixes included, is made by the RedScribe maintainer(s) directly. This isn’t a judgment on the quality of any patch someone might put together; it’s a deliberate choice about how this project is run. If you’d like something changed, open an issue describing it instead of a PR. A maintainer will implement it themselves if it’s a good fit.
If a pull request is opened anyway, expect it to be closed unmerged and pointed back here, rather than reviewed for a possible merge.
Reporting a security vulnerability
Section titled “Reporting a security vulnerability”Do not open a public issue for a security vulnerability in RedScribe
itself. Use GitHub’s private vulnerability reporting (repo’s Security
tab → Report a vulnerability). See .github/SECURITY.md in the repo
for the full policy, including what’s in and out of scope. RedScribe’s own
code and default configuration is in scope. How you secure your own
deployment, and gaps already listed under Alpha status &
versioning’s “Known limitations”
section, are not.