Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 2.63 KB
Raw

Contributing

If you want to contribute to the bower website, fill out the support declaration to gain access to the repository. Alternatively, you can just fork the repository and submit pull requests. There are a few things that you can do:

Writing Documentation

When writing documentation, please remember:

Less talk, More examples

Like this:

## The `blah` command line tool:

`Blah` can be installed through NPM:

  $ npm install blah

Install NPM through brew:

  $ brew install node

Install brew by visiting http://brew.sh or by running:

  $ brew install brew

When you write, try to include an example for each paragraph.

Improving the Website Design

When improving the design, keep this in mind:

  • Keep the page simple
  • Don't add too many pictures (it makes the place look ugly)
  • Stick with the bower color palette
  • It's a good idea to follow the commit rules

Bower Color Palette

These are the same colors used in the bower bird:

Color Hex RGB
#EF5734 239,87,52
#FFCC2F 255,204,47
#2BAF2B 43,175,43
#CECECE 206,206,206
#00ACEE 0,172,238
#543729 84,55,41
#FFFFFF 255,255,255

Commit Rules

Change Examples What to do
Small changes Grammar fixes, adding documentation Direct commit
Bigger changes Website redesign, changing the front page Pull request, discussion about pros/cons, and then merge

If you're unsure, submit a pull request.

Reporting Website Bugs or Errors

Please open an issue if you find any bugs.

Example issue:

I need help with blah blah blah.
The command `blah` isn't working! Here is my command-line output:

> NPM ERR! blah blah blah blah
> NPM ERR! blah blah blah blah