Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jankapunkt opened this issue Aug 16, 2023 · 2 comments
Open

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

jankapunkt opened this issue Aug 16, 2023 · 2 comments
Labels
documentation 📑 Improvements or additions to documentation hacktoberfest

Comments

@jankapunkt
Copy link
Member

jankapunkt commented Aug 16, 2023

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)

@jankapunkt jankapunkt added the documentation 📑 Improvements or additions to documentation label Aug 16, 2023
@jorenvandeweyer
Copy link
Member

Can we set the default branch to merge to development instead of master?

@jankapunkt
Copy link
Member Author

@jorenvandeweyer done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📑 Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants