requests / requests-oauthlib

OAuthlib support for Python-Requests!
https://requests-oauthlib.readthedocs.org/
ISC License
1.71k stars 421 forks source link

Release template purposal #543

Open jtroussard opened 3 months ago

jtroussard commented 3 months ago

Considering the many moving parts of the release process and integration with the PyPi, it would be beneficial to create some sort of release protection or employ a template. I have not researched this specifically but wanted to open the conversation here on this issue to explore the possibilities.

Some specific things to consider could be creating a check list or template guiding team members to:

  1. update README.md if necessary
  2. update setup.py
  3. does the documentation need to be recompiled
  4. determine version update

I imagine there are other points to cover.

Feedback highly encourage, positive/critical any and all welcome.

JonathanHuot commented 3 months ago

We can reuse placeholder here https://github.com/requests/requests-oauthlib/blob/master/docs/contributing.rst?plain=1#L61

jtroussard commented 3 months ago

This is a great place to document, we can flesh this deployment/releases section out for now and see how that serves the community/maintainers.