-
Notifications
You must be signed in to change notification settings - Fork 0
contribute
♥ HTML5 Boilerplate and want to get involved? Thanks! There are plenty of ways you can help!
If you come across an issue with the HTML5 Boilerplate code, we'd really appreciate you taking the time to report it. Please read these guidelines before you submit an issue to the HTML5 Boilerplate issue tracker.
-
Check that the issue has not already been reported. Please use the GitHub issue search to check if someone has already reported the issue. If the issue already exists and you have something to add, please reply to the existing issue.
-
Check that the issue has not been fixed in the latest master code. If the issue doesn't seem to have been reported before, and you've been using the latest stable release, please consider taking a moment to clone or download the latest code from the
masterbranch (which is under continuous development). This way you can be sure that the issue has not already been fixed on themasterbranch. -
Include a reduced test case using jsFiddle. If you can distill the issue into a simple HTML/CSS/JS testcase that others can view, then it makes troubleshooting easier.
Please try to be as detailed as possible in your report too. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? All these details will help us and other contributors detect and fix any potential bugs.
Taking the time to create bug reports is great; submitting patches or new features for review is even better!
First, head over to the Issues tab. Check for any open or closed issues relevant to what you're interested in working on. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue first to check that the work is wanted or matches the goals of the project. For more details, please read: How to properly contribute to open source projects on GitHub.
The best way to get your work merged into the project:
- Fork the project.
- Clone your fork (
git clone git@github.com:<username>/html5-boilerplate.git). - Create a topic branch to contain your change (
git checkout -b my_feature). - Create your changes, run tests, and make sure everything works.
- Commit your changes in logical chunks. Please write good commit messages.
- Push the branch up (
git push origin my_feature). - Open a Pull Request with a clear title and description.
- Four spaces for indentation.
- Double quotes only.
- Include closing tags.
- Omit
/>in self-closing tags like<br>or<img>
- Four spaces for indentation.
- Multi-line approach (also for a sequence of selectors).
- End all declarations with a semi-colon.
- Four spaces for indentation.
- Single quotes only.
Our docs are used by nearly all of our users. They help people to get started with the code, to understand the rationale behind certain decisions, and to explore ways to become better developers. Therefore, quality contributions to our docs - the knowledge that other people have access to - are some of the most important that can be made. If you spot any documentation that you think is a bit thin, out of date, or could benefit from your knowledge and expertise...please edit it!
To help with translation, please submit translations to the html5boilerplate.com repo. It has been translated into 11 languages so far! The htmlboilerplate.com translation wiki has the current translation status and tips on how to contribute.
Most of us can be found in freenode IRC channel #HTML5 and we also have a currently closed Google Group. Please ask us on twitter or StackOverflow (tag the question with html5boilerplate or h5bp) or open an issue on Github.