Skip to content

Commit 8e92cf9

Browse files
authored
📝 Update CHANGELOG.md
- added formatting notes for releases - added notes for PEP0440 styling guide - added additional notes for conversion to semver terminology
1 parent 2a6e5a3 commit 8e92cf9

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

CHANGELOG.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,57 @@
1-
# Changelog
1+
<h1 align = "center">CHANGELOG</h1>
22

3-
All notable changes to `pkg-name` will be documented here. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
3+
<div align = "justify">
4+
5+
All notable changes to this project will be documented in this file. The format is based on
6+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [PEP0440](https://peps.python.org/pep-0440/)
7+
styling guide. For full details, see the [commit logs](https://github.com/sharkutilities/pandas-wizard/commits).
8+
9+
## `PEP0440` Styling Guide
10+
11+
<details>
12+
<summary>Click to open <code>PEP0440</code> Styilng Guide</summary>
13+
14+
Packaging for `PyPI` follows the standard PEP0440 styling guide and is implemented by the **`packaging.version.Version`** class. The other
15+
popular versioning scheme is [`semver`](https://semver.org/), but each build has different parts/mapping.
16+
The following table gives a mapping between these two versioning schemes:
17+
18+
<div align = "center">
19+
20+
| `PyPI` Version | `semver` Version |
21+
| :---: | :---: |
22+
| `epoch` | n/a |
23+
| `major` | `major` |
24+
| `minor` | `minor` |
25+
| `micro` | `patch` |
26+
| `pre` | `prerelease` |
27+
| `dev` | `build` |
28+
| `post` | n/a |
29+
30+
</div>
31+
32+
One can use the **`packaging`** version to convert between PyPI to semver and vice-versa. For more information, check
33+
this [link](https://python-semver.readthedocs.io/en/latest/advanced/convert-pypi-to-semver.html).
34+
35+
</details>
36+
37+
## Release Note(s)
38+
39+
The release notes are documented, the list of changes to each different release are documented. The `major.minor` patch are indicated
40+
under `h3` tags, while the `micro` and "version identifiers" are listed under `h4` and subsequent headlines. The legend for
41+
changelogs are provided in the detail pane, while the version wise note is as available below.
42+
43+
<details>
44+
<summary>Click to open Legend(s) Styilng Guide</summary>
45+
46+
* 🎉 - **Major Feature** : something big that was not available before.
47+
* ✨ - **Feature Enhancement** : a miscellaneous minor improvement of an existing feature.
48+
* 🛠️ - **Patch/Fix** : something that previously didn’t work as documented – or according to reasonable expectations – should now work.
49+
* ⚙️ - **Code Efficiency** : an existing feature now may not require as much computation or memory.
50+
* 💣 - **Code Refactoring** : a breakable change often associated with `major` version bump.
51+
52+
</summary>
53+
</details>
54+
55+
### Version: `XXX` | Release Date:
56+
57+
</div>

0 commit comments

Comments
 (0)