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

Add the "Dev" changelog section #6804

Merged
merged 6 commits into from
Aug 14, 2023
Merged

Add the "Dev" changelog section #6804

merged 6 commits into from
Aug 14, 2023

Conversation

m1r0
Copy link
Member

@m1r0 m1r0 commented Apr 12, 2023

Proposed Changes

  • Add the "Dev" section to the changelog.
  • Add more detailed descriptions of each change log section.
  • Fix the editorconfig for the composer.json file so it uses tabs instead of spaces.

Testing Instructions

  1. Run npm run changelog.
  2. For the change significance step, select one of patch/minor/major.
  3. In the type of change step, make sure there is a dev section.

Pre-Merge Checklist

  • PR title and description contain sufficient detail and accurately describe the changes
  • Acceptance criteria is met
  • Decisions are publicly documented
  • Adheres to coding standards (PHP, JavaScript, CSS, HTML)
  • All strings are translatable (without concatenation, handles plurals)
  • Follows our naming conventions (P6rkRX-4oA-p2)
  • Hooks (p6rkRX-1uS-p2) and functions are documented
  • New UIs are responsive and use a mobile-first approach
  • New UIs match the designs
  • Different user privileges (admin, teacher, subscriber) are tested as appropriate
  • Code is tested on the minimum supported PHP and WordPress versions
  • User interface changes have been tested on the latest versions of Chrome, Firefox and Safari
  • "Needs Documentation" label is added if this change requires updates to documentation
  • Known issues are created as new GitHub issues

@m1r0 m1r0 added this to the 4.14.0 milestone Apr 12, 2023
@m1r0 m1r0 self-assigned this Apr 12, 2023
@m1r0 m1r0 requested a review from a team April 12, 2023 21:40
@codecov
Copy link

codecov bot commented Apr 12, 2023

Codecov Report

Merging #6804 (f2583a2) into trunk (c1a9bb1) will increase coverage by 0.01%.
Report is 51 commits behind head on trunk.
The diff coverage is 79.94%.

Impacted file tree graph

@@             Coverage Diff              @@
##              trunk    #6804      +/-   ##
============================================
+ Coverage     49.32%   49.33%   +0.01%     
- Complexity    10538    10539       +1     
============================================
  Files           575      575              
  Lines         44501    44503       +2     
  Branches        402      402              
============================================
+ Hits          21950    21956       +6     
+ Misses        22224    22220       -4     
  Partials        327      327              
Files Changed Coverage Δ
includes/class-sensei.php 23.41% <0.00%> (ø)
...al/student-progress/tools/class-migration-tool.php 31.03% <31.03%> (ø)
...er/migrations/class-student-progress-migration.php 80.89% <80.89%> (ø)
...ncludes/blocks/class-sensei-block-view-results.php 74.28% <100.00%> (ø)
includes/class-sensei-settings-api.php 15.47% <100.00%> (ø)
includes/class-sensei-settings.php 70.70% <100.00%> (ø)
includes/internal/emails/class-email-sender.php 99.02% <100.00%> (ø)
...ludes/internal/emails/class-email-settings-tab.php 85.82% <100.00%> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6585162...f2583a2. Read the comment docs.

@donnapep
Copy link
Collaborator

donnapep commented Aug 1, 2023

In a team meeting, we decided to tweak this PR to add more detailed descriptions of each change log option, and pair it with a P2 post to explain proper change log entry usage.

@m1r0 m1r0 added this to the 4.16.1 milestone Aug 4, 2023
@m1r0
Copy link
Member Author

m1r0 commented Aug 4, 2023

I've updated the descriptions in 988184c. LMKWYT. 🙂

@m1r0
Copy link
Member Author

m1r0 commented Aug 4, 2023

@donnapep I would like to know if the examples in the descriptions are making sense to you. If not, the future explainer P2 post might have to be in a more detailed format.

@m1r0 m1r0 modified the milestones: 4.16.1, 4.16.2 Aug 11, 2023
Copy link
Collaborator

@donnapep donnapep left a comment

Choose a reason for hiding this comment

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

Looks good! Hope you don't mind, but I tweaked it slightly in f2583a2, and changed one of the descriptions to include template changes for the dev option.

@donnapep donnapep modified the milestones: 4.16.2, 4.16.1 Aug 13, 2023
@m1r0
Copy link
Member Author

m1r0 commented Aug 14, 2023

Looks even better, thanks!

@m1r0 m1r0 merged commit e830669 into trunk Aug 14, 2023
@m1r0 m1r0 deleted the add/dev-changelog-section branch August 14, 2023 11:53
@m1r0 m1r0 mentioned this pull request Aug 31, 2023
14 tasks
@m1r0 m1r0 changed the title Add the "Development" changelog section Add the "Dev" changelog section Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants