diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c2b62d471..a2b73bb1a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,6 +3,7 @@ ## Pull request type + - [ ] Code changes (bugfix, features) - [ ] Code maintenance (refactoring, formatting, tests) @@ -10,11 +11,13 @@ - [ ] Other (please describe): ## 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 +- [ ] `CHANGELOG.md` has been updated (if relevant) ## Current behavior @@ -27,12 +30,12 @@ Enter text here... Enter text here... ## Breaking change - + - [ ] Yes - [ ] No ## Additional information - + Enter text here... diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..f8a6cd6aa --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,81 @@ +# RocketPy Change Log + +All notable changes to `RocketPy` project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + + + +## [Unreleased] - yyyy-mm-dd + +Here we write upgrading notes for brands. It's a team effort to make them as +straightforward as possible. + +### Added + +- DOC: Added this changelog file [#472](https://github.com/RocketPy-Team/RocketPy/pull/472) +- + +### Changed + +- + +### Fixed + +- + +## [v1.1.0] - 2023-11-19 + +You can install this version by running `pip install rocketpy==1.1.0` + +### Added + +- DOC: Documentation for Function Class Usage [#465](https://github.com/RocketPy-Team/RocketPy/pull/465) +- DOC: first simulation all_info [#466](https://github.com/RocketPy-Team/RocketPy/pull/466) +- ENH: draw motors [#436](https://github.com/RocketPy-Team/RocketPy/pull/436) +- DOC: add documentation for flight data export. [#464](https://github.com/RocketPy-Team/RocketPy/pull/464) +- ENH: Add mass_flow_rate() to GenericMotor class [#459](https://github.com/RocketPy-Team/RocketPy/pull/459) +- DOC: Add documentation on how to build the docs [#452](https://github.com/RocketPy-Team/RocketPy/pull/452) +- ENH: new Flight.get_solution_at_time() method [#441](https://github.com/RocketPy-Team/RocketPy/pull/441) +- ENH: rocket drawing [419](https://github.com/RocketPy-Team/RocketPy/pull/419) +- ENH: Adding Stability Margin with Mach dependency [#377](https://github.com/RocketPy-Team/RocketPy/pull/377) + +### Changed + +- ENH: Spherical Caps Included in Total Length [#455](https://github.com/RocketPy-Team/RocketPy/pull/455) + - Important: This changes behavior of `TankGeometry.add_spherical_caps()` +- ENH: Clean Plots and Prints sub packages init files [#457](https://github.com/RocketPy-Team/RocketPy/pull/457) +- ENH: Add \_MotorPlots Inheritance to Motor Plots Classes [#456](https://github.com/RocketPy-Team/RocketPy/pull/456) +- DOC: organize flight examples folder [#429](https://github.com/RocketPy-Team/RocketPy/pull/429) +- DOC: improve mass and inertia docs [#445](https://github.com/RocketPy-Team/RocketPy/pull/445) + +### Fixed + +- MNT: Refactor exhaust velocity calculation to avoid ZeroDivisionError [#470](https://github.com/RocketPy-Team/RocketPy/pull/470) +- BUG: Fix find_input() Function to Return a Single Value [#471](https://github.com/RocketPy-Team/RocketPy/pull/471) +- DOC: refactor dispersion analysis notebook [#463](https://github.com/RocketPy-Team/RocketPy/pull/463) +- BUG: User input checks added for Function class [#451](https://github.com/RocketPy-Team/RocketPy/pull/451) +- DOC: fix positions and coordinate system documentation page [#454](https://github.com/RocketPy-Team/RocketPy/pull/) +- MNT: fix env plots legends [#440](https://github.com/RocketPy-Team/RocketPy/pull/440) +- BUG: flight.prints.max_values() fails when launching an EmptyMotor [#438](https://github.com/RocketPy-Team/RocketPy/pull/438) +- BUG: Maintaining Extrapolation when Adding Discrete Functions with Constants [#432](https://github.com/RocketPy-Team/RocketPy/pull/432) +- MNT: Fix env plots max heights [#433](https://github.com/RocketPy-Team/RocketPy/pull/433)