Skip to content

Update changelog, contributing, and releasing docs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sallyhall merged 1 commit into from
Jan 28, 2026
Merged

Update changelog, contributing, and releasing docs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## 0.1.0 - 2026-01-28

Initial release
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
51 changes: 0 additions & 51 deletions NEWS.md
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down