Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

91 lines (66 loc) · 2.9 KB
Raw

Contributing to Gollum

Thanks for your interest in the gollum project!

Submitting an Issue

Please note that the issue tracker is meant for:

  1. Bug reports.
  2. Feature requests.

If your have problems using or installing the software which stem from bugs in the software or a lack of documentation, we are always happy to help out! However, for ordinary usage questions, please consider asking elsewhere, for instance on StackOverflow.

Gollum supports custom macros for the creation of additional wiki markup tags. Please do not use this tracker to request macros specific to your situation. However, if you have or are working on a macro that you think may be useful to more users, you can share it as a GitHub gist and link to it in the wiki.

Before submitting an issue, please carefully look through the following places to make sure your problem is not already addressed:

  1. The issue tracker.
  2. The README.
  3. The project's wiki.

Lastly, please consider helping out by opening a Pull Request!

Opening a Pull Request

Pull Requests fixing bugs, implementing new features, or updating documentation and dependencies are all very welcome! If you would like to help out with the project, you can pick an open issue from the issue tracker. We're more than happy to help you get started! Here's how you can proceed:

  1. Fork and clone Gollum.
  2. Create a thoughtfully named topic branch to contain your changes.
  3. If you haven't installed dependencies yet, navigate to your clone and execute: 
    [sudo] bundle install
  4. Hack away.
  5. Add your own tests and make sure they're all still passing.
  6. If some of your changes deserve a mention on Gollum's home page, edit the README accordingly.
  7. If necessary, rebase your commits into logical chunks, without errors.
  8. Push the branch to your fork on GitHub.
  9. Create a pull request for Gollum.

Notes:

  • Do not change Gollum's version numbers, we will do that on our own.

Running tests

  1. Install Bundler.
  2. Navigate to the cloned source of Gollum.
  3. Install dependencies: 
    [sudo] bundle install
  4. Run the tests: 
    bundle exec rake test

Working with test repositories

An example of how to add a test file to the bare repository lotr.git.

mkdir tmp
cd tmp
git clone ../lotr.git/
git log
echo "test" > test.md
git add .
git commit -am "Add test"
git push ../lotr.git/ master

Releasing the gem

Gollum uses Semantic Versioning.

x.y.z

For z releases:

rake bump
rake release

For x.y releases:

# First update VERSION in lib/gollum.rb and then:
rake gemspec
rake release