Skip to content

Commit 96829fd

Browse files
committed
docs: update the releasing guidelines
1 parent 25c57f9 commit 96829fd

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ own script**
3939
* [Example](#example)
4040
* [Handling Errors](#handling-errors)
4141
* [Development](#development)
42+
* [Debugging](#debugging)
43+
* [Releasing](#releasing)
4244
* [Contributing](#contributing)
4345
* [Commit message guidelines](#commit-message-guidelines)
4446
* [Pull request guidelines](#pull-request-guidelines)
@@ -47,7 +49,7 @@ own script**
4749

4850
## Installation
4951

50-
Install this bundler plugin as follows:
52+
Install the `bundler gem-bytes` command as follows:
5153

5254
```shell
5355
bundle plugin install bunder-gem_bytes
@@ -79,11 +81,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
7981
workflow. You can also run `bin/console` for an interactive prompt that will allow
8082
you to experiment.
8183

82-
To install this gem onto your local machine, run `bundle exec rake install`. To
83-
release a new version, update the version number in `version.rb`, and then run
84-
`bundle exec rake release`, which will create a git tag for the version, push git
85-
commits and the created tag, and push the `.gem` file to
86-
[rubygems.org](https://rubygems.org).
84+
### Debugging
8785

8886
To debug this gem it is recommended that you create a test project and install
8987
this plugin with bundler from source code as follows:
@@ -113,6 +111,25 @@ BUNDLE_IGNORE_CONFIG=TRUE bundle gem-bytes gem_bytes_script.rb
113111
# Repeat 4 - 6 until satisified :)
114112
```
115113

114+
### Releasing
115+
116+
To release a new version of this gem, run `create-github-release [TYPE]` where
117+
TYPE is MAJOR, MINOR, or PATCH according to SemVer based on the changes that
118+
have been made since the last release:
119+
120+
* MAJOR: changes that break compatibility with previous versions, such as removing a
121+
public method, changing a method signature, or modifying the expected behavior of a
122+
method.
123+
* MINOR: changes that add new features, enhance existing features, or deprecate
124+
features in a backward-compatible way, such as adding a new method or improving
125+
performance without breaking existing functionality.
126+
* PATCH: changes that fix bugs or make other small modifications that do not affect
127+
the API or alter existing functionality, such as fixing user-facing typos or
128+
updating user documentation.
129+
130+
This command must be run from the project root directory with a clean worktree on the
131+
default branch.
132+
116133
## Contributing
117134

118135
Bug reports and pull requests are welcome on GitHub at

0 commit comments

Comments
 (0)