Contributing

Bug reports and pull requests are welcome on GitLab at https://gitlab.com/appraisal-rb/appraisal2
. 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.

We so if you make changes, remember to update it.

You can help!

Simply follow these instructions:

Join the Discord:
Fork the repository
Create your feature branch (git checkout -b my-new-feature)
Make some fixes.
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Make sure to add tests for it. This is important, so it doesn’t break in a future release.
Run the at least one workflow of tests via act, e.g.,:
```
 act -W '.github/workflows/ruby-3-3.yml'
```
NOTE: Because there are so many workflows, running act naked might grind your machine to a halt.
Create new Pull Request.
Announce it in the channel for this org in the Discord!

NOTE: Run tests with act to have confidence they will pass in CI.
Also, because the spec run makes many changes to local bundle config,
many specs will fail locally in subsequent runs unless run via act.
The spec suite is not idempotent. This is a goal for the future, if you’d like to work on it.

The Reek List

Take a look at the reek list which is the file called REEK and find something to improve.

To refresh the reek list:

bundle exec reek > REEK

Run Tests

To run all tests against the current Ruby release:

bundle exec rake act

Or the equivalent:

act -W '.github/workflows/current.yml'

NOTE: Because there are so many workflows, running act naked might grind your machine to a halt.

Lint It

Run all the default tasks, which includes running the gradually autocorrecting linter, rubocop-gradual.

bundle exec rake

Or just run the linter.

bundle exec rake rubocop_gradual:autocorrect

Contributors

Your picture could be here!

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/appraisal-rb/appraisal2/-/graphs/main

For Maintainers

One-time, Per-maintainer, Setup

IMPORTANT: If you want to sign the build you create,
your public key for signing gems will need to be picked up by the line in the
gemspec defining the spec.cert_chain (check the relevant ENV variables there).
All releases to RubyGems.org will be signed.
See: RubyGems Security Guide

NOTE: To build without signing the gem you must set SKIP_GEM_SIGNING to some value in your environment.

To release a new version:

Run bin/setup && bin/rake as a tests, coverage, & linting sanity check
Update the version number in version.rb, and ensure CHANGELOG.md reflects changes
Run bin/setup && bin/rake again as a secondary check, and to update Gemfile.lock
Run git commit -am "🔖 Prepare release v<VERSION>" to commit the changes
Run git push to trigger the final CI pipeline before release, & merge PRs
- NOTE: Remember to check the build!
Run export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME
Run git checkout $GIT_TRUNK_BRANCH_NAME
Run git pull origin $GIT_TRUNK_BRANCH_NAME to ensure you will release the latest trunk code
Set SOURCE_DATE_EPOCH so rake build and rake release use same timestamp, and generate same checksums
- Run export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH
- If the echo above has no output, then it didn’t work.
- Note that you’ll need the zsh/datetime module, if running zsh.
- In older versions of bash you can use date +%s instead, i.e. export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH
Run bundle exec rake build
Run bin/gem_checksums (more context 1, 2)
to create SHA-256 and SHA-512 checksums. This functionality is provided by the stone_checksums
gem.
- Checksums will be committed automatically by the script, but not pushed
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