updating contribute section

This commit is contained in:
davegandy 2013-05-09 00:04:35 -04:00
parent 726093e638
commit 076588b2c3
2 changed files with 37 additions and 17 deletions

View file

@ -34,32 +34,46 @@
</ol>
</div>
<section>
<h2 class="page-header">GitHub Project</h2>
<p class="lead">
Found a bug? Want to request a new icon? Want to see what's up next for the project?
<a href="{{ site.font_awesome.github.url }}/issues">Submit an issue</a> or a
<a href="{{ site.font_awesome.github.url }}/pulls">pull request</a> on the
<a href="{{ site.font_awesome.github.url }}">GitHub project</a>. Here are a few guidelines:
<section id="bugs">
<h2 class="page-header">Reporting Bugs</h2>
<p>
Found a problem with Font Awesome? Feel free to submit an issue on the GitHub project. But please keep the following in mind:
</p>
<ol>
<li>Be nice. No one likes a jackass.</li>
<li>Check to see if your issue you want to open already exists. Search is a beautiful invention. <i class="icon-smile"></i></li>
<li>Please be nice. Font Awesome is a happy place.</li>
<li>Please <a href="{{ site.font_awesome.github.url }}/search?type=Issues">search</a> to see if your icon request already exists.</li>
<li>
If you're making a request for a new icon, it's helpful if you include the following:
<ul>
<li>Title your request <code>Icon request: icon-name</code></li>
<li>Icon use cases. How do you want to be using it?</li>
<li>Attach an image or two that represent the idea you're going for. Remember that font icons are a single color.</li>
</ul>
Before opening any issue, please read the generic <a href="https://github.com/necolas/issue-guidelines">issue
guidelines</a>, by <a href="https://github.com/necolas/">Nicolas Gallagher</a>.
</li>
<li>
If you're submitting a pull request, make it on the latest -wip branch. All pull requests against master will be
ignored.
After doing everything above, feel free to
<a href="{{ site.font_awesome.github.url }}/issues/new">submit an issue</a>.
</li>
</ol>
</section>
<section id="pull-requests">
<h2 class="page-header">Submitting Pull Requests</h2>
Found a way to solve a bug in Font Awesome? Want to contribute new features? Here are a few things to remember:
<ol>
<li>Please submit all pull requests against *-wip branches.</li>
<li>All pull requests submitted against master will be sumarily closed and this guide referenced.</li>
<li>
After doing everything above, feel free to
<a href="{{ site.font_awesome.github.url }}/issues/new">submit a pull request</a>.
</li>
</ol>
</section>
<section id="milestones">
<h2 class="page-header">Project Milestones</h2>
<p>
Want to keep up with what's planned for Font Awesome? Check out our
<a href="{{ site.font_awesome.github.url }}/issues/milestones">milestones</a> on the GitHub project.
</p>
</section>
<section id="say-thanks">
<h2 class="page-header">Say Thanks</h2>
<p class="lead">

View file

@ -8,6 +8,12 @@ $(function() {
$('pre').addClass('prettyprint');
window.prettyPrint && prettyPrint();
// Disable links with href="#" inside <section>, so users can click on them
// to preview :active state without being scrolled up to the top of the page.
$('section a[href="#"]').click(function(e) {
e.preventDefault();
e.stopPropagation();
});
// // inject twitter & github counts
// $.ajax({
// url: 'http://api.twitter.com/1/users/show.json',