Skip to content

Contribution guidelines do not cover how to PR fixes for docs #221

Open
@jankapunkt

Description

@jankapunkt

The documentation does require to start PRs from development. However, the readthedocs.io always points to master and fixes for stable docs should therefore be made by pointing to master and starting from master.

Otherwise we might face the uncomfortable situation of

  • either merging unstable code from development into master
  • or have to wait for the fix to be released until development is stable and mergeable

The contribution guidelines should therefore have their own section on how to contribute to the docs.

See #220 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation 📑Improvements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions