Contributing

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:

Syntax highlighting - see github/linguist
Markdown on GitHub - contact support@github.com
Styling issues on GitHub - contact support@github.com

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

Submitting a Pull Request

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

Testing

To run the tests:

$ rake

If nothing complains, congratulations!

Releasing a new version

If you are the current maintainer of this gem:

Bump the version number in lib/github-markup.rb, adhering to Semantic Versioning
Update HISTORY.md
Test the latest version on GitHub
Build the new version with rake build
Copy pkg/github-markup*.gem to vendor/cache in your local checkout of GitHub
Update the version for github-markup in the Gemfile
Run bundle update --local github-markup
Run any relevant tests and test it manually from the browser.
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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!