contributing

Contributing information for GitHub and documentation, plus GitHub issue templates.

Functions:

github_bash_block(*commands)

Formats the given commands in a reStructuredText bash code block suitable for rendering on GitHub.

make_contributing(repo_path, templates)

Add CONTRIBUTING.rst to the desired repo.

make_docs_contributing(repo_path, templates)

Add CONTRIBUTING.rst to the documentation directory of the repo.

make_issue_templates(repo_path, templates)

Add issue templates for GitHub to the desired repo.
github_bash_block(*commands)[source]

Formats the given commands in a reStructuredText bash code block suitable for rendering on GitHub.

Parameters

commands

Return type

str

make_contributing(repo_path, templates)[source]

Add CONTRIBUTING.rst to the desired repo.

Parameters

  • repo_path (Path) – Path to the repository root.

  • templates (Environment)

Return type

List[str]

make_docs_contributing(repo_path, templates)[source]

Add CONTRIBUTING.rst to the documentation directory of the repo.

Parameters

  • repo_path (Path) – Path to the repository root.

  • templates (Environment)

Return type

List[str]

make_issue_templates(repo_path, templates)[source]

Add issue templates for GitHub to the desired repo.

Parameters

  • repo_path (Path) – Path to the repository root.

  • templates (Environment)

Return type

List[str]