Permalink
Find file Copy path
57 lines (37 sloc) 2.44 KB

Contributing

Contributions to this project are released to the public under the project's open source license.

This project adheres to a Code of Conduct. By participating, you are expected to honor this code.

This library's only job is to decide which markup format to use and call out to an external library to convert the markup to HTML (see the README for more information on how markup is rendered on GitHub.com).

If you are having an issue with:

Anything else - search open issues or create an issue and and we'll help point you in the right direction.

Submitting a Pull Request

  1. Fork it.
  2. Create a branch (git checkout -b my_markup)
  3. Commit your changes (git commit -am "Added Snarkdown")
  4. Push to the branch (git push origin my_markup)
  5. Open a Pull Request
  6. Enjoy a refreshing Diet Coke and wait

dependencies

You can run script/bootstrap.contrib to fetch them all.

Testing

To run the tests:

$ rake

If nothing complains, congratulations!

Releasing a new version

If you are the current maintainer of this gem:

  1. Bump the version number in lib/github-markup.rb, adhering to Semantic Versioning
  2. Update HISTORY.md
  3. Test the latest version on GitHub
  4. Build the new version with rake build
  5. Copy pkg/github-markup*.gem to vendor/cache in your local checkout of GitHub
  6. Update the version for github-markup in the Gemfile
  7. Run bundle update --local github-markup
  8. Run any relevant tests and test it manually from the browser.
  9. Push the new gem release with rake release. If you don't have permission to release to rubygems.org, contact one of the existing owners (gem owners github-markup) and ask them to add you.