Contributing to Beefy's Address Book
=======

We really appreciate and value contributions to the Beefy.Finance repositories. Please take 5' to review the items listed below to make sure that your contributions are merged as soon as possible.

## Creating Pull Requests (PRs)

As a contributor, you are expected to fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo/) for how this works.

## A typical workflow

1) Make sure your fork is up to date with the main repository:

```
cd address-book
git remote add upstream https://github.com/beefyfinance/address-book.git
git fetch upstream
git pull --rebase upstream master
```
NOTE: The directory `address-book` represents your fork's local copy.

2) Branch out from `master` into `<platform name>`:
```
git checkout -b pancakeswap
```

3) Make your changes, add your files, commit, and push to your fork.

```
git add address-book/bsc/pancake.ts
git commit -m "Added pancakeswap addresses"
git push origin pancakeswap
```

4) Go to [github.com/beefyfinance/address-book](https://github.com/beefyfinance/address-book) in your web browser and issue a new pull request.

5) Maintainers will review your code and possibly ask for changes before your code is pulled in to the main repository. We'll check that all tests pass, review the coding style, and check for general code correctness. If everything is OK, we'll merge your pull request and your code will be part of Beefy's address book.

*IMPORTANT* Please pay attention to the maintainer's feedback, since its a necessary step to keep up with the standards Beefy.Finance attains to.

## All set!

If you have any questions, feel free to post them to [github.com/beefyfinance/address-book/issues](https://github.com/beefyfinance/address-book/issues).

Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/beefyfinance/address-book/issues?q=label%3A%22good+first+issue%22).

Thanks for your time and code!