README.md in countless-1.1.0 vs README.md in countless-1.2.0
- old
+ new
@@ -17,11 +17,13 @@
- [Installation](#installation)
- [Requirements](#requirements)
- [Usage](#usage)
- [Addtional Configuration](#addtional-configuration)
- [Development](#development)
+- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
+- [Releasing](#releasing)
## Installation
Add this line to your gemspec/Gemfile:
@@ -259,24 +261,32 @@
}
}.deep_merge(config.additional_annotation_patterns)
end
```
-
-
-
-
## Development
After checking out the repo, run `make install` to install dependencies. Then,
run `make test` to run the tests. You can also run `make shell-irb` for an
interactive prompt that will allow you to experiment.
-To release a new version, update the version number in `version.rb`, and then
-run `make release`, which will create a git tag for the version, push git
-commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Code of Conduct
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
+
## Contributing
Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/countless.
+https://github.com/hausgold/countless. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/countless/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.