Change package to semantic versioning and indicate stable

andrewtavis · Dec 28, 2021 · edbbb11 · edbbb11
1 parent 4529832
commit edbbb11
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,16 @@
-### poli-sci-kit 0.1.2.5 (March 24, 2021)
+# Changelog
+
+poli-sci-kit tries to follow [semantic versioning](https://semver.org/), a MAJOR.MINOR.PATCH version where increments are made of the:
+
+- MAJOR version when we make incompatible API changes
+- MINOR version when we add functionality in a backwards compatible manner
+- PATCH version when we make backwards compatible bug fixes
+
+# poli-sci-kit 1.0.0 (December 28th, 2021)
+
+- Release switches poli-sci-kit over to [semantic versioning](https://semver.org/) and indicates that it is stable
+
+### poli-sci-kit 0.1.2.5 (March 24th, 2021)
 
 Changes include:
 
@@ -7,11 +19,11 @@ Changes include:
 - Checks for code quality have been added
 - Examples now function in Google Colab
 
-### poli-sci-kit 0.1.0 (Feb 10, 2021)
+### poli-sci-kit 0.1.0 (Feb 10th, 2021)
 
 First stable release of poli-sci-kit
 
-Additions include:
+Changes include:
 
 - Plotting functions for parliament allocations and seat disproportionality
 - Full documentation of the package
@@ -20,10 +32,10 @@ Additions include:
 - Extensive testing of all modules with GH Actions and Codecov
 - Code of conduct and contribution guidelines
 
-### poli-sci-kit 0.0.2.1 (Dec 9, 2020)
+### poli-sci-kit 0.0.2.1 (Dec 9th, 2020)
 
 The minimum viable product of poli-sci-kit
 
-- Users are able to do political appointments using a variety of methods including largest   remainder and highest averages techniques
+- Users are able to do political appointments using a variety of methods including largest remainder and highest averages techniques
 - Users are able to analyze the results of appointments
 - Usage examples have been created
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,7 @@
 author = "poli-sci-kit developers"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.2.9"
+release = "1.0.0"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/setup.py b/setup.py
@@ -18,7 +18,7 @@
     name="poli-sci-kit",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    version="0.1.2.9",
+    version="1.0.0",
     author="Andrew Tavis McAllister",
     author_email="[email protected]",
     classifiers=[