Contributing

Jump to bottom

philosowaffle edited this page Jul 23, 2014 · 7 revisions

###General Development

Create and issue here, or choose an issue to work on.
Choose an appropriate milestone if none is selected and assign it to yourself
Check out the project from Github
Create a branch named issue-#
Add your feature
Write unit tests
Run bundle install followed by bundle exec rake and ensure everything completes successfully.

###Full Test

gem build docme.gemspec
sudo gem install docme-<version>.gem
docme parse test from the root project directory
Look to see that a docme_site folder is created and open the index.html file in the browser to confirm everything built correctly.

###Pull Request

Finally, push your branch out and submit a pull request.
On the pull request page you should be able to see if travis builds your changes successfully. If there are problems with the build, make the fix and push new commits out to your same branch. Travis will try to build again.