Contents

# Contributing to Authlogic

## Issues

### Security Issues

**Do not disclose security issues in public.** Instead, please email:

```
Ben Johnson <[e-mail]>,
Tieg Zaharia <[e-mail]>
Jared Beck <[e-mail]>
```

We will review security issues promptly.

### Non-Security Issues

Please use github issues only for bug reports and feature requests.

### Usage Questions

Please ask usage questions on
[stackoverflow](http://stackoverflow.com/questions/tagged/authlogic).

## Development

Most local development should be done using the oldest supported version of
ruby. See `required_ruby_version` in the gemspec.

### Testing

Tests can be run against different versions of Rails like so:

```
BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle install
BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle exec rake
```

To run a single test:

```
BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x \
  bundle exec ruby -I test path/to/test.rb
```

Bundler can be omitted, and the latest installed version of a gem dependency
will be used. This is only suitable for certain unit tests.

```
ruby –I test path/to/test.rb
```

### Linting

Running `rake` also runs a linter, rubocop. Contributions must pass both
the linter and the tests. The linter can be run on its own.

```
BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle exec rubocop
```

To run the tests without linting, use `rake test`.

```
BUNDLE_GEMFILE=test/gemfiles/Gemfile.rails-4.2.x bundle exec rake test
```

### Release

1. Update version number in lib/authlogic/version.rb
1. Add release date to changelog entry
1. Add a new "Unreleased" section at top of changelog
1. Commit with message like "Release 3.6.0"
1. git tag -a -m "v3.6.0" "v3.6.0" # or whatever number
1. git push --tags origin 3-stable # or whatever branch
1. gem build authlogic.gemspec
1. gem push authlogic-3.6.0

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
authlogic-4.2.0	CONTRIBUTING.md
authlogic-4.1.1	CONTRIBUTING.md
authlogic-4.1.0	CONTRIBUTING.md