Contributing Docs

osa_tool.operations.docs.community_docs_generation.contributing

ContributingBuilder

Builds the CONTRIBUTING.md Markdown documentation file for the project.

acknowledgements property

Returns the acknowledgements section content.

before_pr property

Generates the checklist section for contributors before submitting a pull request.

documentation property

Generates the documentation resources section link.

guide property

Generates the guide section with basic project contribution instructions.

introduction property

Generates the introduction section of the contributing guidelines.

readme property

Generates the README file link section.

tests property

Generates the test resources section link.

build()

Assembles and saves the CONTRIBUTING.md file from template sections. Returns: Has the task been completed successfully

load_template()

Loads a TOML template file and returns its sections as a dictionary.