Merge pull request #472 from RocketPy-Team/doc/add-changelog

DOC: Add RocketPy change log file

Author: Gui-FernandesBR

.github/pull_request_template.md

@@ -3,18 +3,21 @@
 <!-- You may use this template to describe your Pull Request. But if you believe there is a better way to express yourself, don't hesitate! -->
 
 ## Pull request type
+<!-- Remove unchecked box items. -->
 
 - [ ] Code changes (bugfix, features)
 - [ ] Code maintenance (refactoring, formatting, tests)
 - [ ] ReadMe, Docs and GitHub updates
 - [ ] Other (please describe):
 
 ## Checklist
+<!-- Remove irrelevant items to this PR. -->
 
 - [ ] 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
 <!-- Describe current behavior or link to an issue. -->
@@ -27,12 +30,12 @@ Enter text here...
 Enter text here...
 
 ## Breaking change
-<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
+<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. Remove the unchecked box item. -->
 
 - [ ] Yes
 - [ ] No
 
 ## Additional information
-<!-- Include any relevant details or screenshots. -->
+<!-- Include any relevant details or screenshots. If none, remove this section. -->
 
 Enter text here...

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/).
+
+<!-- Types of changes:
+    - `Added` for new features.
+    - `Changed` for changes in existing functionality.
+    - `Deprecated` for soon-to-be removed features.
+    - `Removed` for now removed features.
+    - `Fixed` for any bug fixes.
+    - `Security` in case of vulnerabilities.
+
+    Should not be here:
+    - tests
+    - github maintenance
+    - merge commits
+
+    Types of messages:
+    - Usually the message is the PR title and number
+    - If the PR is too long to accomplish all the changes (it shouldn't be...),
+      you can use a second line to describe it
+
+-->
+
+## [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)