Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Latest commit

 

History

History
44 lines (30 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.6 KB
Raw

Contributing to webauthn-ruby

How?

  • Creating a new issue to report a bug
  • Creating a new issue to suggest a new feature
  • Commenting on an existing issue to answer an open question
  • Commenting on an existing issue to ask the reporter for more details to aid reproducing the problem
  • Improving documentation
  • Creating a pull request that fixes an issue (see beginner friendly issues)
  • Creating a pull request that implements a new feature (worth first creating an issue to discuss the suggested feature)

Development

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

Some tests require stubbing time with libfaketime in order to pass, otherwise they're skipped. You can install this library with your package manager. Follow libfaketime's instructions for your OS to preload the library before running the tests, and use the FAKETIME_NO_CACHE=1 option. E.g. when installed via homebrew on macOS:

DYLD_INSERT_LIBRARIES=/usr/local/Cellar/libfaketime/2.9.7_1/lib/faketime/libfaketime.1.dylib DYLD_FORCE_FLAT_NAMESPACE=1 FAKETIME_NO_CACHE=1 bundle exec rspec

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then 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.

Styleguide

Ruby

We use rubocop to check ruby code style.

Git commit messages

We try to follow Conventional Commits specification since v1.17.0.

On top of fix and feat types, we also use optional:

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to the CI configuration files and scripts
  • docs: Documentation only changes
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Partially inspired in Angular's Commit Message Guidelines.