node-oauth2-server icon indicating copy to clipboard operation
node-oauth2-server copied to clipboard

Contribution guidelines do not cover how to PR fixes for docs

Open jankapunkt opened this issue 1 year ago • 2 comments

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 https://github.com/node-oauth/node-oauth2-server/pull/220#issuecomment-1679954963

jankapunkt avatar Aug 16 '23 04:08 jankapunkt

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

jorenvandeweyer avatar Aug 26 '23 07:08 jorenvandeweyer

@jorenvandeweyer done

jankapunkt avatar Aug 26 '23 07:08 jankapunkt