We love pull requests from everyone. Follow these steps to get started:
Fork, then clone the repo:
git clone [email protected]:your-username/api-docs.git
Follor the set up guide as seen in the readme.
Run the server locally and verify the changes display correctly for major web browsers:
bundle exec middleman server
Push to your fork and submit a pull request.
At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Follow the thoughtbot style guide.
- Write a good commit message.