4.0 KiB
Contributing
Thanks for your interest in PaperTrail!
Reporting Security Vulnerabilities
Please email jared@jaredbeck.com and batkinz@gmail.com. Do not mention the vulnerability publicly until there's a fix.
We will respond as soon as we can. Thank you for responsibly disclosing security vulnerabilities.
Usage Questions
Due to limited volunteers, we cannot answer usage questions. Please ask such questions on StackOverflow.
Reporting Bugs
You want to fix a bug, but need some help.
You are required to provide a script that reproduces the bug, using our template. You are required to fix the bug. We're here to help, but no one else will fix it for you. If you don't fix the bug in a reasonable amount of time, your issue will be closed.
- From our issue template.
Due to limited volunteers, we cannot fix everyone's bugs for them. We're happy to help, but we can only accept issues from people committed to working on their own problems.
Different people use different parts of PaperTrail. You may have found a bug, but you might also be the only person affected by that bug. Don't hesitate to ask for whatever help you need, but it's your job to fix it.
Development
gem install bundler
bundle
bundle exec appraisal install
bundle exec appraisal update # occasionally
Testing is a little awkward because the test suite:
- Supports multiple versions of rails
- Contains a "dummy" rails app with three databases (test, foo, and bar)
- Supports three different RDBMS': sqlite, mysql, and postgres
Test sqlite, AR 6
DB=sqlite bundle exec appraisal rails-6.0 rake
Test sqlite, AR 5
DB=sqlite bundle exec appraisal rails-5.2 rake
Test mysql, AR 5
DB=mysql bundle exec appraisal rails-5.2 rake
Test postgres, AR 5
createuser --superuser postgres
DB=postgres bundle exec appraisal rails-5.2 rake
The dummy_app
In the rare event you need a console
in the dummy_app
:
cd spec/dummy_app
cp config/database.mysql.yml config/database.yml
BUNDLE_GEMFILE='../../gemfiles/rails_5.2.gemfile' bin/rails console -e test
Adding new schema
Edit spec/dummy_app/db/migrate/20110208155312_set_up_test_tables.rb
. Migration
will be performed by rake
, so you can just run it as shown above. Also,
spec/dummy_app/db/schema.rb
is deliberately .gitignore
d, we don't use it.
Lowest supported ruby version
Set in three files:
- .gemspec (required_ruby_version)
- .rubocop.yml (TargetRubyVersion)
- .github/workflows/test.yml, in two places
Practically, this is only changed when dropping support for an EoL ruby version.
We .gitignore
.ruby-version
because it is variable, and only used by
contributors.
Documentation
Generate the Table of Contents
yarn global add markdown-toc
markdown-toc -i --maxdepth 3 --bullets='-' README.md
Releases
- Prepare the appropriate "stable" branch for release, eg.
10-stable
- git checkout 10-stable
- Checkout a new branch, eg.
release-10.3.0
- Merge the relevant changes from
master
. This could be a plain merge, or it could be cherry-picking. The later is more common in backports. - Set the version in
lib/paper_trail/version_number.rb
- In the changelog, - Replace "Unreleased" with the date in ISO-8601 format - Add a new "Unreleased" section
- In the readme, update references to version number, including - documentation links table - compatability table, if necessary
- git commit -am 'Release 10.3.0'
- git push origin release-10.3.0
- Pull request into
10-stable
, CI pass, merge PR - Release
- git checkout 10-stable && git pull
- gem build paper_trail.gemspec
- gem push paper_trail-10.3.0.gem
- git tag -a -m "v10.3.0" "v10.3.0" # or whatever number
- git push --tags origin
- Cleanup
- git checkout master
- cherry-pick the "Release 10.3.0" commit from the
10-stable
branch - git push origin master