This repository has been archived by the owner on Dec 11, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 973
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reorganize docs, add contributing guide
- Loading branch information
1 parent
8799d91
commit 8182366
Showing
3 changed files
with
49 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
8182366
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++ thanks for doing this.