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

[PR #8066/cba34699 backport][3.9] 💅📝 Restructure the changelog for clarity #8068

Conversation

webknjaz
Copy link
Member

This is a backport of PR #8066 as merged into master (cba3469).

PR #8066

(cherry picked from commit cba3469)

What do these changes do?

Are there changes in behavior for the user?

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

@webknjaz webknjaz added enhancement documentation Improvements or additions to documentation infra labels Jan 28, 2024
@webknjaz webknjaz requested a review from asvetlov as a code owner January 28, 2024 02:32
@psf-chronographer psf-chronographer bot added bot:chronographer:provided There is a change note present in this PR labels Jan 28, 2024
@webknjaz webknjaz merged commit 419d715 into aio-libs:3.9 Jan 28, 2024
23 of 25 checks passed
@webknjaz webknjaz deleted the patchback/backports/3.9/cba346995b953b23421079ee0bccdfe85d736e7a/pr-8066 branch April 19, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR documentation Improvements or additions to documentation enhancement infra
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant