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

chore(docs): add release note guidelines #4551

Merged
merged 20 commits into from
Nov 21, 2022

Conversation

Yun-Kim
Copy link
Contributor

@Yun-Kim Yun-Kim commented Nov 15, 2022

Description

This change adds a new section for release note guidelines, and a new reno template which should allow more consistency in our release notes moving forward.

Checklist

Motivation

Design

Testing strategy

Relevant issue(s)

Testing strategy

Reviewer Checklist

  • Title is accurate.
  • Description motivates each change.
  • No unnecessary changes were introduced in this PR.
  • Avoid breaking API changes unless absolutely necessary.
  • Tests provided or description of manual testing performed is included in the code or PR.
  • Release note has been added for fixes and features, or else changelog/no-changelog label added.
  • All relevant GitHub issues are correctly linked.
  • Backports are identified and tagged with Mergifyio.

@Yun-Kim Yun-Kim added the changelog/no-changelog A changelog entry is not required for this PR. label Nov 15, 2022
@Yun-Kim Yun-Kim requested a review from a team as a code owner November 15, 2022 19:11
@Yun-Kim Yun-Kim force-pushed the yunkim/release-notes-documentation branch from c11c32a to e8b0e88 Compare November 15, 2022 19:25
docs/index.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
docs/release_note_guidelines.rst Outdated Show resolved Hide resolved
releasenotes/template-release-note.yaml Show resolved Hide resolved
releasenotes/template-release-note.yaml Outdated Show resolved Hide resolved
@Yun-Kim Yun-Kim force-pushed the yunkim/release-notes-documentation branch from e8b0e88 to 5392cbf Compare November 15, 2022 19:35
Copy link
Member

@Kyle-Verhoog Kyle-Verhoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we also update the PR checklist with a link to this new documentation? (the link will probably be broken until we do the next release)

@Yun-Kim Yun-Kim force-pushed the yunkim/release-notes-documentation branch 8 times, most recently from 0b15f97 to 0ec78e5 Compare November 15, 2022 21:30
@Yun-Kim Yun-Kim force-pushed the yunkim/release-notes-documentation branch from 0ec78e5 to c5e6d18 Compare November 15, 2022 21:55
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
docs/contributing.rst Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
docs/contributing.rst Outdated Show resolved Hide resolved
@Yun-Kim Yun-Kim force-pushed the yunkim/release-notes-documentation branch from af17329 to b2e8e99 Compare November 16, 2022 18:33
Kyle-Verhoog
Kyle-Verhoog previously approved these changes Nov 16, 2022
Copy link
Member

@Kyle-Verhoog Kyle-Verhoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 it!!

docs/contributing.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@mabdinur mabdinur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥳

Copy link
Contributor

@majorgreys majorgreys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want this to be the same scope used in the conventional commits, we need them to conform to the same format, which means lower case and shorter. But then we might end up making it harder for someone skimming release notes for the changes related to their use of the library.

docs/contributing.rst Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Merging #4551 (e33c90c) into 1.x (e82c3d4) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head e33c90c differs from pull request most recent head eeb0e95. Consider uploading reports for the commit eeb0e95 to get more accurate results

@@           Coverage Diff           @@
##              1.x    #4551   +/-   ##
=======================================
  Coverage   77.95%   77.95%           
=======================================
  Files         759      759           
  Lines       60125    60125           
=======================================
+ Hits        46872    46873    +1     
+ Misses      13253    13252    -1     
Impacted Files Coverage Δ
tests/utils.py 90.35% <0.00%> (-0.24%) ⬇️
ddtrace/internal/telemetry/writer.py 77.24% <0.00%> (+0.68%) ⬆️
ddtrace/internal/remoteconfig/worker.py 100.00% <0.00%> (+4.34%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mergify mergify bot merged commit 2331b19 into DataDog:1.x Nov 21, 2022
@Yun-Kim Yun-Kim deleted the yunkim/release-notes-documentation branch November 21, 2022 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants