Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.

Commit

Permalink
Reorganize docs, add contributing guide
Browse files Browse the repository at this point in the history
Fix #206

Auditors: @bbondy
  • Loading branch information
diracdeltas committed Apr 13, 2016
1 parent 8799d91 commit 8182366
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 15 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing to browser-laptop

Brave welcomes contributions via [pull requests](https://github.com/brave/browser-laptop/pulls). Below are a few guidelines we ask of contributors:

## Before you make changes

* Submit a [ticket](https://github.com/brave/browser-laptop/issues) for your issue if one does not already exist. Please include the Brave version, operating system, and steps to reproduce the issue. Note that this is not necessary for trivial changes (spelling fixes, minor documentation changes, etc).
* For changes to javascript files, we recommend installing a [Standard](http://standardjs.com/) plugin for your preferred text editor in order to ensure code style consistency.

## Making changes

* Make commits in logical units. If needed, run `git rebase -i` to squash commits before opening a pull request.
* Use Github [auto-closing keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) in the commit message, and make the commit messsage body as descriptive as necessary. Ex:

````
Add contributing guide
This is a first pass at a contributor's guide so now people will know how to
get pull requests accepted faster.
Fix #206
````

* Run the tests by running `npm run watch-test` and `npm test` in separate terminals.
* Make sure [Flow](http://flowtype.org/) type checking passes: `npm run-script flow`. BONUS: Help us out by adding more [Flow type annotations](http://flowtype.org/blog/2015/02/20/Flow-Comments.html) to new and existing Brave code!

## Pull requests

Feel free to tag a Brave employee in the pull request to assign them to review your code. For design-related changes, it is helpful to include screenshots.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,34 @@

# Brave Browser

Laptop and Desktop browser for OS X, Windows and Linux.
Desktop browser for OS X, Windows and Linux. To download the latest release,
go to https://github.com/brave/browser-laptop/releases. To build Brave from
source code, see below.

## Requirements
## Build prerequisites

### All platforms
1. `nodejs` **`>= 5.0`**

Install from your package manager or download from https://nodejs.org

2. `node-gyp` **`3.2.1`**

sudo npm install -g node-gyp@3.2.1
[Prerequisites](https://github.com/brave/browser-laptop/blob/master/docs/prerequisites.md) for Windows

### Windows
Ensure you have the following installed:

* [Node.js 5+](https://nodejs.org/en/)
* [Python 2.7](https://www.python.org/downloads/)
* [Visual Studio 2013 or 2015](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)

### Linux
* `apt-get install libgnome-keyring-dev`

## Installation

Make sure you have all of the pre-requisite compilers/applications [Installed](https://github.com/brave/browser-laptop/blob/master/docs/prerequisites.md)
After installing the prerequisites:

1. Clone the git repository from GitHub:

Expand Down Expand Up @@ -89,6 +99,11 @@ Build instructions:
- [Windows build instructions](https://github.com/brave/electron/blob/master/docs/development/build-instructions-windows.md)
- [Linux build instructions](https://github.com/brave/electron/blob/master/docs/development/build-instructions-linux.md)

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.


## Packaging for bundles, installers, and updates

### OSX:
Expand Down
10 changes: 0 additions & 10 deletions docs/prerequisites.md

This file was deleted.

1 comment on commit 8182366

@bbondy
Copy link
Member

@bbondy bbondy commented on 8182366 Apr 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ thanks for doing this.

Please sign in to comment.