Bugs and Features
If you’ve found a Haml bug, or you have something you’d like to see in the language, by all means speak up! Report it on the issue tracker and I’ll try to follow up with you as soon as I can. Please include the following information in your report:
- What version of Haml you’re using (run
haml --versionon the command line)
- If the issue has to do with Rails, what version of Rails you’re using (
- If possible, a simple Haml template that displays the bug — preferably one that can be run with the command line
The more information you can provide, the faster it’ll be to fix your bug!
While bug reports and feature requests are great, actual code fixing the bugs or implementing the features is even better. If you’ve got some code to contribute, first read the information below, then fork the Haml repository and send a pull request. I’ll do a code review of your patch, and then chances are good I’ll merge it right in.
Haml has two primary branches. stable is where the development of the released version (currently 5.0.0) takes place. This is where most bug fixes should go. Master, on the other hand, is where the next version of Haml is being developed. This is the place for new features. Please submit your changes to the appropriate branch.
When Making a Patch, Please:
- Make sure your commit message is properly capitalized and punctuated
- Make sure the first line of your commit message is a (short) full sentence
- Add unit tests
- Add a note to the changelog (
CHANGELOG.md) describing your change. Feel free to add
(thanks [Your Name](Your Website))at the end
- Make sure your commits don’t add any new whitespace (use
git diff --check)
- If you’re implementing a user-visible change, add it to the reference (