Skip to content

Commit b341c1d

Browse files
committed
Update branding w/ asottile ownership
1 parent 77b5fd9 commit b341c1d

File tree

5 files changed

+35
-37
lines changed

5 files changed

+35
-37
lines changed

base.mako

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<link rel="stylesheet" type="text/css" href="build/main.css">
88
<link rel="icon" href="favicon.ico">
99
<meta name="viewport" content="width=device-width, initial-scale=1">
10-
<title>pre-commit by Yelp</title>
10+
<title>pre-commit</title>
1111
</head>
1212
<body class="page-${template_name}" data-spy="scroll" data-target=".pc-sidebar">
1313
<header class="navbar navbar-default pc-nav" role="banner">
@@ -37,11 +37,10 @@
3737
</header>
3838
<div class="top-shelf">
3939
<div class="container">
40-
<img class="pc-darwin hidden-xs hidden-sm" src="pre-commit-darwin.png">
40+
<img class="pc-logo-top-shelf hidden-xs hidden-sm" src="logo-top-shelf.png">
4141
<h1>
4242
<a href="http://github.com/pre-commit/pre-commit">
4343
pre-commit
44-
<span class="nowrap">by Yelp</span>
4544
</a>
4645
</h1>
4746
<p>A framework for managing and maintaining multi-language <span class="nowrap">pre-commit</span> hooks.</p>
@@ -57,11 +56,7 @@
5756
<div class="container pc-main-content">
5857
${self.body()}
5958
</div>
60-
<footer class="pc-footer">
61-
<div class="container">
62-
Brought to you by <a href="http://www.yelp.com">Yelp</a>. Check out some of our other <a href="http://yelp.github.io/">open source projects</a> on <a href="https://github.com/yelp/">GitHub</a>.
63-
</div>
64-
</footer>
59+
<footer class="pc-footer"><div class="container"></div></footer>
6560
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
6661
<script src="node_modules/bootstrap-sass/assets/javascripts/bootstrap.min.js"></script>
6762
<script>

index.mako

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,43 @@
1717
<div class="page-header">
1818
<h1>Introduction</h1>
1919
</div>
20+
===============================================================================V
2021
<p>
21-
At Yelp we rely heavily on pre-commit hooks to find and fix common issues before
22-
changes are submitted for code review. We run our hooks before every commit to
23-
automatically point out issues like missing semicolons, whitespace problems, and
24-
testing statements in code. Automatically fixing these issues before posting
25-
code reviews allows our code reviewer to pay attention to the architecture of a
26-
change and not worry about trivial errors.
22+
Git hook scripts are useful for identifying simple issues
23+
before submission to code review. We run our hooks on every
24+
commit to automatically point out issues in code such as
25+
missing semicolons, trailing whitespace, and debug statements.
26+
By pointing these issues out before code review, this allows a
27+
code reviewer to focus on the architecture of a change while
28+
not wasting time with trivial style nitpicks.
2729
</p>
2830
<p>
29-
As we created more libraries and projects we recognized that sharing our pre
30-
commit hooks across projects is painful. We copied and pasted bash scripts
31-
from project to project and had to manually change the hooks to work for
31+
As we created more libraries and projects we recognized that
32+
sharing our pre-commit hooks across projects is painful. We
33+
copied and pasted unwieldy bash scripts from project to
34+
project and had to manually change the hooks to work for
3235
different project structures.
3336
</p>
3437
<p>
35-
We believe that you should always use the best industry standard linters. Some
36-
of the best linters are written in languages that you do not use in your project
37-
or have installed on your machine. For example scss-lint is a linter for SCSS
38-
written in Ruby. If you’re writing a project in node you should be able to use
39-
scss-lint as a pre-commit hook without adding a Gemfile to your project or
40-
understanding how to get scss-lint installed.
41-
</p>
42-
<p>
43-
We built pre-commit to solve our hook issues. It is a multi-language package
44-
manager for pre-commit hooks. You specify a list of hooks you want and
45-
pre-commit manages the installation and execution of any hook written in any
46-
language before every commit. pre-commit is specifically designed to not require
47-
root access. If one of your developers doesn’t have node installed but modifies
48-
a JavaScript file, pre-commit automatically handles downloading and building node
49-
to run jshint without root.
38+
We believe that you should always use the best industry
39+
standard linters. Some of the best linters are written in
40+
languages that you do not use in your project or have
41+
installed on your machine. For example scss-lint is a linter
42+
for SCSS written in Ruby. If you’re writing a project in node
43+
you should be able to use scss-lint as a pre-commit hook
44+
without adding a Gemfile to your project or understanding how
45+
to get scss-lint installed.
46+
</p>
47+
<p>
48+
We built pre-commit to solve our hook issues. It is a
49+
multi-language package manager for pre-commit hooks. You
50+
specify a list of hooks you want and pre-commit manages the
51+
installation and execution of any hook written in any language
52+
before every commit. pre-commit is specifically designed to not
53+
require root access. If one of your developers doesn’t have
54+
node installed but modifies a JavaScript file, pre-commit
55+
automatically handles downloading and building node to run
56+
eslint without root.
5057
</p>
5158
</div>
5259

logo-top-shelf.png

17.7 KB
Loading

pre-commit-darwin.png

-21.1 KB
Binary file not shown.

scss/main.scss

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ h1,
5959
position: relative;
6060
}
6161

62-
.pc-darwin {
62+
.pc-logo-top-shelf {
6363
float: right;
6464
margin: -30px 20px 0 40px;
6565
}
@@ -68,10 +68,6 @@ h1,
6868
font-weight: bold;
6969
margin: 40px 0 20px;
7070

71-
span {
72-
font-weight: normal;
73-
}
74-
7571
a {
7672
color: $pc-yellow;
7773

0 commit comments

Comments
 (0)