Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 2.79 KB
Raw

Contributing to svgeez

There are a couple ways you can help improve svgeez:

  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

svgeez is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using Travis CI.

Before making changes to svgeez, you'll want to install Ruby 2.4.6. It's recommended that you use a Ruby version managment tool like rbenv, chruby, or rvm. Once you've installed Ruby 2.4.6 using your method of choice, install the project's gems by running:

bundle install

…from the root of the project.

In order for the test suite to run properly, SVGO must be installed (and the svgo command must be available in your PATH). This is most easily achieved by installing Node.js and running:

npm install -g svgo

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. Build (bin/rake build) and install (bin/rake install) your updated code.
  6. If your changes would benefit from testing, add the necessary tests and verify everything passes by running bin/rake.
  7. 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.)
  8. Push the branch to your fork: git push -u origin my-new-feature.
  9. 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 you install the EditorConfig plugin for your editor of choice.

Additionally, Rubocop can be used to help identify possible trouble areas in your code. Run bin/rubocop to generate Rubocop's static code analysis report.

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.