Contribution guidelines
We welcome your contributions but note that:
- We cannot guarantee when your pull requests (PRs) will be reviewed.
- Review does not guarantee acceptance or merging.
- We may reject PRs with content (e.g., AI-generated) that does not meet our quality standards.
Maintainers, see Maintainer notes.
Before you start
- Contributor License Agreement: Docsy contributions require the CNCF CLA, enforced on every PR through EasyCLA.
- Code of conduct: this project follows the LF Projects Code of Conduct.
- Code reviews: all submissions, including those from project members, are reviewed as pull requests.
Report a vulnerability
Report it privately, as the security policy describes.
Make a change
To request a feature or report a problem, open an issue. For a page of this guide, Create documentation issue at the top right opens one titled after the page.
The Docsy repo is a monorepo, with the theme in theme/ and this guide in
docsy.dev/. Fork it and open a pull request, as a draft when you’re not ready
for review. For a page of this guide, Edit this page opens its source in
your fork, ready for a pull request.
Every pull request gets a Netlify deploy preview (the Details link of its deploy-preview check). A theme can’t be served on its own: locally, build this guide, which uses the repo’s own theme, or test a theme change through the example site against your local Docsy.
Follow the style guide, and run the checks before pushing.
Feedback
Cette page est-elle utile?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.