Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.38 KB

Contributing to Rambling Trie

  1. If you have found a bug or have a feature request, please search through the issues to see if it has already been reported. If that's not the case, then create a new one with a full description of what you have found or what you need.

  2. If you have bug fix or a feature implementation in mind, then fork Rambling Trie and create a branch with a descriptive name.

  3. Get the gem up and running locally (tests are written in RSpec):

    bundle install
    bundle exec rake
  4. Implement your bug fix or feature - make sure to add tests!

  5. Make a Pull Request

    Before doing so:

    git remote add upstream git@github.com:gonzedge/rambling-trie.git
    git checkout main
    git pull upstream
    git checkout my-feature-branch
    git rebase main
    git push --set-upstream origin my-feature-branch

Feel free to reach out to @gonzedge with any questions.