pboling/gem_bench

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
## Contributing

Bug reports and pull requests are welcome on GitLab at [https://github.com/pboling/gem_bench][🚎src-main]
. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
the [code of conduct][conduct].

To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request
and post a message to the [gitter chat][🏘chat].

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

## Release

To release a new version:

1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
2. update the version number in `version.rb`
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
4. Double check the `CHANGELOG.md`, make sure changes are documented
5. run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
6. Run `git push` to trigger the final CI pipeline before release, & merge PRs
7. Run `git checkout main` (Or whichever branch is considered `trunk`, e.g. `master`)
8. Run `git pull origin main` to ensure you will release the latest trunk code.
9. Run `bundle exec rake build`
10. Run `bin/checksum` to create and commit the SHA256 & SHA512 checksums
11. Run `bundle exec rake release`

NOTE: You will need to have a public key in `certs/`, and list your cert in the
`gemspec`, in order to sign the new release.
See: [RubyGems Security Guide][rubygems-security-guide]

## Contributors

[![Contributors](https://contrib.rocks/image?repo=pboling/gitmoji-regex)][🖐contributors]

Made with [contributors-img][contrib-rocks].

[🖐contributors]: https://github.com/pboling/gem_bench/graphs/contributors
[contrib-rocks]: https://contrib.rocks
[conduct]: https://github.com/pboling/gem_bench/blob/main/CODE_OF_CONDUCT.md
[🚎src-main]: https://github.com/pboling/gem_bench/tree/main
[🏘chat]: https://matrix.to/#/%23pboling_gem_bench:gitter.im
[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
[rubygems]: https://rubygems.org