From f201d1d6bee5e18482b209193aaf467fe99e100f Mon Sep 17 00:00:00 2001 From: Sally Hall Date: Wed, 28 Jan 2026 15:46:41 -0500 Subject: [PATCH] Update changelog, contributing, and releasing docs --- CHANGELOG.md | 5 +++++ CONTRIBUTING.md | 7 ++++--- NEWS.md | 51 ------------------------------------------------- RELEASING.md | 4 ++-- 4 files changed, 11 insertions(+), 56 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 NEWS.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..525ce34 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 0.1.0 - 2026-01-28 + +Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c623aba..c9905c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,20 +12,21 @@ issue trackers, chatrooms, and mailing lists. ## Contributing Code -$(INSTALL_DEPENDENCIES) Fork the repo. + `bundle install` + Make sure the tests pass: - $(TEST_RUNNER) + `bundle exec rspec` Make your change, with new passing tests. Follow the [style guide][style]. [style]: https://github.com/thoughtbot/guides/tree/master/style Mention how your changes affect the project to other developers and users in the -`NEWS.md` file. +`CHANGELOG.md` file. Push to your fork. Write a [good commit message][commit]. Submit a pull request. diff --git a/NEWS.md b/NEWS.md deleted file mode 100644 index 532aa3b..0000000 --- a/NEWS.md +++ /dev/null @@ -1,51 +0,0 @@ -# News - -All notable changes to this project will be documented in this file. - -The format is loosely based on [Keep a Changelog] and this project adheres to -[Semantic Versioning]. - - [Keep a Changelog]: http://keepachangelog.com/ - [Semantic Versioning]: http://semver.org/ - -## [Unreleased] - -### Added - -- This is for new features. - -### Changed - -- This is for changes in existing functionality. - -### Deprecated - -- This is for once-stable features removed in upcoming releases. - -### Removed - -- This is for deprecated features removed in this release. - -### Fixed - -- This is for any bug fixes. - -### Security - -- This is to invite users to upgrade in case of vulnerabilities. - - [Unreleased]: https://github.com/thoughtbot/michel/compare/v0.2.0...HEAD - -## [0.0.2] - 2016-02-01 - -### Added - -- This version to show how each version title is linked (`## [0.0.2]`). - - [0.2.0]: https://github.com/thoughtbot/michel/compare/v0.1.0...v0.2.0 - -## 0.0.1 - 2016-01-01 - -### Added - -- This `NEWS.md` file. diff --git a/RELEASING.md b/RELEASING.md index 637a458..2b1a78e 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,7 +4,7 @@ Include an RC (release candidate) number if appropriate, e.g. 2.0.0.rc. -## 2. Update `NEWS.md` or `CHANGELOG.md` to reflect the changes since last release +## 2. Update `CHANGELOG.md` to reflect the changes since last release You can copy [GitHub automatically generated release notes] for this step. @@ -30,7 +30,7 @@ gem push project-name-*.gem If the project is hosted on RubyGems, consider using [RubyGems Trusted Publication] to automatically push the release using a GitHub action. -## 7. Add a new GitHub release using the recent `NEWS.md` or `CHANGELOG.md` as the content +## 7. Add a new GitHub release using the recent `CHANGELOG.md` as the content Sample URL: https://github.com/thoughtbot/project-name/releases/new?tag=vVERSION