Contributing to Barman#
Barman is an open-source project and we welcome contributions from the community.
Follow these guidelines when playing with Barman code and contributing patches to the project.
- Setting up a development installation
- Writing code
- Writing and running tests
- Writing and building documentation
- Style guide
- Tense and voice
- Future and conditional tenses
- Person
- Line length
- Sentence length
- Contractions
- Numbers
- Dates
- Capitalization
- Punctuation
- “This” without a noun
- Directing users up and down through a topic
- Bold (text)
- Courier (AKA inline code or monospace
text) - Code blocks
- Italics (text)
- Links
- Admonitions (notes, warnings, hints, etc.)
- Tables
- Lists
- Images
- Cross-reference labels standard
- Building the documentation
- Style guide
- Opening a PR