Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 2.6 KB
Raw

Contributing

Bug reports and pull requests are welcome on GitLab at https://gitlab.com/rubocop-lts/standard-rubocop-lts . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of 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.

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. Run git commit -am "🔖 Prepare release v<VERSION>" to commit the changes
  5. Run git push to trigger the final CI pipeline before release, & merge PRs a. NOTE: Remember to check the build!
  6. Run git checkout main (Or whichever branch is considered trunk, e.g. master)
  7. Run git pull origin main to ensure you will release the latest trunk code.
  8. Set SOURCE_DATE_EPOCH so rake build and rake release use same timestamp, and generate same checksums a. Run export SOURCE_DATE_EPOCH=$EPOCHSECONDS (you'll need the zsh/datetime module, if running zsh)
  9. Run bundle exec rake build
  10. Run bin/checksums to create SHA-256 and SHA-512 checksums a. Checksums will be committed automatically by the script, but not pushed
  11. Run bundle exec rake release which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org

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

Contributors

Contributors

Contributors Parade (GitHub Only) made with contributors-img.