diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md index 2600446..a16da13 100644 --- a/.github/CHANGELOG.md +++ b/.github/CHANGELOG.md @@ -1,62 +1,53 @@ # Changelog -## v1.1.1 +All notable changes to this project will be documented in this file. -### Added or Changed +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -- Misc. Bug Fixes +## [1.1.2] - 2024-04-28 -### Removed - -- N/A - -## v1.1.0 +### Fixed -### Added or Changed +- This CHANGELOG file. -- Update CREDITS file, finalized project table, revised multiple guides +## [1.1.1] - 2024-02-19 -### Removed +### Fixed -- Jekyll build and cache files from the repository +- Misc. Bug Fixes. -## v1.0.2 +## [1.1.0] - 2024-02-15 -### Added or Changed +### Changed -- Update requirements file, removed unneeded dependencies +- Update CREDITS file, finalized project table, revised multiple guides. ### Removed -- N/A - -## v1.0.1 - -### Added or Changed +- Jekyll build and cache files from the repository. -- Minor security fixes and enhancements +## [1.0.2] - 2024-01-19 ### Removed -- N/A +- Update requirements file, removed unneeded dependencies. -## v1.0.0 +## [1.0.1] - 2024-01-09 -### Added or Changed +### Changed -- Official Release of PRG +- Minor security fixes and enhancements. -### Removed - -- N/A - -## v1.0-beta.1 +## [1.0.0] - 2023-12-12 -### Added or Changed +### Added -- Added this changelog file :D -- Beta release of PRG - -### Removed +- Official Release of PRG. -- N/A +[1.1.2]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/compare/v1.1.1...v1.1.2 +[1.1.1]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/compare/v1.1.0...v1.1.1 +[1.1.0]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/compare/v1.0.2...v1.1.0 +[1.0.2]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/compare/v1.0.1...v1.0.2 +[1.0.1]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/compare/v1.0.0...v1.0.1 +[1.0.0]: https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/releases/tag/v1.0.0 diff --git a/guidelines/category_guidelines.md b/guidelines/category_guidelines.md index 2379ad1..49ba608 100644 --- a/guidelines/category_guidelines.md +++ b/guidelines/category_guidelines.md @@ -180,4 +180,7 @@ Consult this guideline for detailed information on the categorization of each ti > If you choose to not use GitHub pages, make sure you change the username in the badge to your own to link to your forked repositories Project Tier Table markdown file. ## Resources -- [Try a Semantic Approach to Naming GitHub Repositories](https://moduscreate.com/blog/github-semantic-naming/) - A great article on naming conventions for GitHub repositories. This article made me consider the naming conventions for **PRG**. \ No newline at end of file +- [Try a Semantic Approach to Naming GitHub Repositories](https://moduscreate.com/blog/github-semantic-naming/) + - A great article on naming conventions for GitHub repositories. This article made me consider the naming conventions for **PRG**. +- [Semantic Versioning](https://semver.org/) +- [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) diff --git a/guidelines/repository_structure_guidelines.md b/guidelines/repository_structure_guidelines.md index ae481f9..7c92f20 100644 --- a/guidelines/repository_structure_guidelines.md +++ b/guidelines/repository_structure_guidelines.md @@ -92,22 +92,24 @@ This guideline details necessary files and overall structure for your repository > **OPTIONAL** file for **ALL** tiers. - This file contains a list of changes for each version of your project. +- Use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for your changelog. - Follow [Semantic Versioning](https://semver.org/) guidelines. - - Given a version number **MAJOR.MINOR.PATCH** (e.g. 1.0.0), increment the: - - **MAJOR** version when you make incompatible API changes - - **MINOR** version when you add functionality in a backward compatible manner - - **PATCH** version when you make backward compatible bug fixes + - Given a version number **X.Y.Z** (**MAJOR.MINOR.PATCH**) (e.g. 1.0.0), increment the: + - **MAJOR** version when you make incompatible API changes. + - **MINOR** version when you add functionality in a backward compatible manner. + - **PATCH** version when you make backward compatible bug fixes. + - A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers, and MUST NOT contain leading zeroes. - Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. + - For pre-release and build metadata, use the labels **alpha**, **beta**, **rc**, and **build** using the format **MAJOR.MINOR.PATCH-label.build**. - Examples: - - 1.0.0-alpha.1 - - 1.0.0-beta.2 - - 1.0.0-rc.1 + - 1.0.0-alpha + - 1.0.0-beta + - 1.0.0-rc - **rc** stands for release candidate, which is a beta version with potential to be a final product, which is ready to release unless significant bugs emerge. - - **alpha** and **beta** are used for pre-release versions - - **build** is used to identify a build + - **alpha** and **beta** are used for pre-release versions. + - **build** is used to identify a build. - This scheme is not strictly enforced, but it is recommended by the Semantic Versioning (SemVer) specification, highlighted in their 2.0.0 release [here](https://semver.org/spec/v2.0.0.html#spec-item-9). -- Use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for your changelog **Resources:** > [Semantic Versioning](https://semver.org/)