# Contributing

If you're reading this, it means you want to contribute to this project. Hooray!

Here's what to do:

1. If you're looking for a task to work on, check the
   ["up-for-grabs" issues](https://github.com/JacobEvelyn/friends/labels/upforgrabs). If you see something there that catches your
   eye, leave a comment indicating you'll work on it and
   it's yours! If you already have something to work on,
   that's great as well!
2. Fork the repository (https://github.com/JacobEvelyn/friends/fork).
3. Clone your forked repository.
4. From within the repository directory, run
   `bundle install` to install all dependencies needed for development.
5. Create your feature branch
   (`git checkout -b my-new-feature`).
6. Make your changes. Add or modify tests if necessary!
   (Run tests with `bundle exec rake test`.) Do your best to conform to
   existing style and commenting patterns. You can run the local version of the
   `friends` script with `bundle exec bin/friends`.
7. Update the `README.md` as necessary to include your changes.
8. Check your changes for code style by running `bundle exec rubocop .` in
   the repository directory. You may see output indicating that some lines
   differ from the style guidelines. Change your code so that Rubocop gives
   no warnings or errors (and don't hesitate to reach out if you don't know how!—this practice is meant to keep the code clean but it shouldn't be
   scary and it's totally fine to need help!).
9. Commit your changes
   (`git commit -am "Add some feature"`).
10. Push your changes to GitHub, and open a pull request.
11. Your code will be reviewed and merged as quickly as
    possible!
12. Check yourself out on the [contributors page](https://github.com/JacobEvelyn/friends/graphs/contributors)! Look at how cool you are!

If you have any questions at all or get stuck on any step,
don't hesitate to
[open a GitHub issue](https://github.com/JacobEvelyn/friends/issues/new)!
I'll respond as quickly as I can, and I'm friendly! I
promise I don't bite. 😊

## Code of Conduct

Note that this project follows a [Code of Conduct](https://github.com/JacobEvelyn/friends/blob/master/CODE_OF_CONDUCT.md).
If you're a polite, reasonable person you won't have any issues!

## Financial contributions

`friends` is a volunteer project. If you find it useful, please consider
making a small donation (🙏) to show you appreciate its continued development.

👇 Donate with these buttons! 👇

[![Backers on Open Collective](<https://opencollective.com/friends/backers_(Open_Collective)/badge.svg>)](https://opencollective.com/friends#backer) [![Sponsors on Open Collective](<https://opencollective.com/friends/sponsors_(Open_Collective)/badge.svg>)](https://opencollective.com/friends#sponsor)
[![Support via Patreon](https://img.shields.io/badge/support-Patreon-green.svg)](https://www.patreon.com/jacobevelyn)
[![Donate via Liberapay](https://img.shields.io/badge/donate-Liberapay-green.svg)](https://liberapay.com/jacobevelyn/donate)
[![Donate via PayPal](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
[![Flattr this](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=jacobevelyn&url=https://github.com/JacobEvelyn/friends&title=friends&tags=github&category=software)
[![Donate bitcoin](https://img.shields.io/badge/donate-Bitcoin-green.svg)](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)

👆 Donate with these buttons! 👆

## Contributors

Thank you to all the lovely people who have already contributed to `friends`!
You folks make `friends` great.
<a href="graphs/contributors"><img src="https://opencollective.com/friends/contributors.svg?width=890" /></a>