Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 2.32 KB
Raw

Contributing to webmention-client-ruby

There are a couple ways you can help improve webmention-client-ruby:

  1. Fix an existing Issue and submit a Pull Request.
  2. Review open Pull Requests.
  3. Report a new Issue. Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue.

Getting Started

webmention-client-ruby is developed using Ruby 3.3.0 and is tested against additional Ruby versions using GitHub Actions.

Before making changes to webmention-client-ruby, you'll want to install Ruby 3.3.0. Using a Ruby version managment tool like rbenv, chruby, or rvm is recommended. Once you've installed Ruby 3.3.0 using your method of choice, install the project's gems by running:

bundle install

Making Changes

  1. Fork and clone the project's repo.
  2. Install development dependencies as outlined above.
  3. Create a feature branch for the code changes you're looking to make: git checkout -b my-new-feature.
  4. Write some code!
  5. If your changes would benefit from testing, add the necessary tests and verify everything passes by running bundle exec rspec.
  6. Commit your changes: git commit -am 'Add some new feature or fix some issue'. (See this excellent article for tips on writing useful Git commit messages.)
  7. Push the branch to your fork: git push -u origin my-new-feature.
  8. Create a new Pull Request and we'll review your changes.

Code Style

Code formatting conventions are defined in the .editorconfig file which uses the EditorConfig syntax. There are plugins for a variety of editors that utilize the settings in the .editorconfig file. We recommended installing the EditorConfig plugin for your editor of choice.

Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.