Skip to content

Commit

Permalink
small update - will continue soon
Browse files Browse the repository at this point in the history
breaking into sections
  • Loading branch information
bsclifton authored Oct 1, 2019
1 parent 93fd424 commit 09b38b4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ After finishing the steps for your platform (ex: after you run `npm i && npm run

The actual build process- it's up to you if you want to run it. It would be great to help ensure the code compiles, but at the same time, it can take several hours (6+ on a laptop) to compile the entire project (and you can submit patches without testing locally and a Brave team member can help you test / verify the fix)

## Setting up a fork and creating your patch
For submitting the patch, you'll want to fork the [brave/brave-core](https://github.com/brave/brave-core) repo if you haven't already and update your remote list (under `src/brave`) to add your fork in there (ex: `git remote add <your-github-username> git@github.com:<your-github-username>/brave-core.git`). You can then create a branch off master for your work and push that to your remote. Once pushed, GitHub will show a "pull request" button the UI which let's you submit the patch against [brave/brave-core](https://github.com/brave/brave-core)

Tests are encouraged - although there's a learning curve. I'd be happy to help when you get further along

## Keeping your fork up-to-date
Once you have a fork, you'll want to keep it up to date.

```
git rebase origin/master
```

0 comments on commit 09b38b4

Please sign in to comment.