X Tutup
Skip to content

DOC: Add RocketPy change log file#472

Merged
Gui-FernandesBR merged 3 commits intodevelopfrom
doc/add-changelog
Nov 20, 2023
Merged

DOC: Add RocketPy change log file#472
Gui-FernandesBR merged 3 commits intodevelopfrom
doc/add-changelog

Conversation

@Gui-FernandesBR
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR commented Nov 20, 2023 •
edited
Loading

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Tests for the changes have been added (if needed)
  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest --runslow) have passed locally

Current behavior

We often forget about what is being included in our releases.

New behavior

There's this CHANGELOG.md special file in the RocketPy root folder. This follows some internet standard format https://keepachangelog.com/en/1.1.0/

The idea is to update the changelog file every time we submit a PR that rings either a code addition, code change or code fix.
We must be short in the descriptions.

Breaking change

  • Yes
  • No

Additional information

Accepting suggestions before merging.
Thanks for bringing this out @giovaniceotto .

@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Nov 20, 2023
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Nov 20, 2023
@Gui-FernandesBR Gui-FernandesBR self-assigned this Nov 20, 2023
@Gui-FernandesBR Gui-FernandesBR changed the base branch from master to develop November 20, 2023 00:20
giovaniceotto
giovaniceotto approved these changes Nov 20, 2023
View reviewed changes
Copy link
Member

@giovaniceotto giovaniceotto left a comment

Choose a reason for hiding this comment

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

Great reference to https://keepachangelog.com/en/1.1.0/ @Gui-FernandesBR.

I have added a new checkbox to the PR template, leading users to update the new file.

@codecov
Copy link

codecov bot commented Nov 20, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d7e4dba) 70.80% compared to head (a78d073) 70.80%.
Report is 9 commits behind head on develop.

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

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop     #472   +/-   ##
========================================
  Coverage    70.80%   70.80%           
========================================
  Files           55       55           
  Lines         9234     9234           
========================================
  Hits          6538     6538           
  Misses        2696     2696
Flag Coverage Δ
unittests 70.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Gui-FernandesBR
Copy link
Member Author

Gui-FernandesBR commented Nov 20, 2023

I almost forgot to include the link of this PR to the changelog.

All good now, thanks for the help @giovaniceotto !

@Gui-FernandesBR Gui-FernandesBR merged commit 3d3d982 into develop Nov 20, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the doc/add-changelog branch November 20, 2023 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@giovaniceotto giovaniceotto giovaniceotto approved these changes

@MateusStano MateusStano Awaiting requested review from MateusStano

@phmbressan phmbressan Awaiting requested review from phmbressan

Assignees

@Gui-FernandesBR Gui-FernandesBR

Labels

Docs Docs and examples related

Projects

No open projects
LibDev Roadmap
Status: Closed

Milestone

Release v1.X.0

Development

Successfully merging this pull request may close these issues.

2 participants

@Gui-FernandesBR @giovaniceotto
X Tutup