# Contributing to Akita

_These guidelines are still in progress! :)
We'd like to add beginner issues and tag our issues so that it's easier for
those interested to join our effort. Stay tuned for that!_

Here's how you can get involved:

- [Open an Issue](#open-an-issue)
- [Contribute Code](#contribute-code)
	- [Implement Your Changes](#implement-your-changes)
	- [Open a Pull Request](#open-a-pull-request)
- [When in doubt, don't hesitate to bark at us 🐶](#when-in-doubt-dont-hesitate-to-bark-at-us-) 

## Open an Issue

Akita Issue List: [https://github.com/esse-dev/akita/issues](https://github.com/esse-dev/akita/issues)

Please let us know if Akita isn't working for you! Feel free to create a new
issue or comment on an existing one. We'd love it if you could include as much
detail as you can to reproduce the problem - if you have screenshots, that's a
huge bonus!

We're always looking to make Akita better, so definitely drop us a Feature Request
if you have any ideas brewing!

Issue Templates you can choose from:

- 📄 [Create New Blank Issue](https://github.com/esse-dev/akita/issues/new?assignees=&labels=&template=blank-issue.md&title=)
- 🐞 [Create New Bug Report](https://github.com/esse-dev/akita/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D)
- 💡 [Create New Feature Request](https://github.com/esse-dev/akita/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE+REQUEST%5D)

## Contribute Code

Before contributing code to Akita please read [Akita's Privacy Policy](docs/PrivacyPolicy.md) so you
can help us ensure data privacy for Akita users! If you make any changes that affect user data,
please review the Privacy Policy to check if any updates should be made to it alongside your changes.

### Implement Your Changes
1. Fork Akita and clone your fork
2. Create a new branch with a name that reflects your changes
3. Code away!
4. Test your changes in Firefox and in Chrome ([How to install Akita in your browser from source](https://github.com/esse-dev/akita/blob/master/docs/InstallAkita.md#step-2-install-akita-in-your-browser))
5. Push your changes to your branch
6. Open a Pull Request in Akita! 🎉

### Open a Pull Request

Akita Pull Requests: https://github.com/esse-dev/akita/pulls

- Please use a pull request title that describes your work
- Include an explanation for your changes and your reasoning behind it
- Link existing issues or pull requests that are relevant

Once you've submitted a pull request (PR), Elliot and/or Sharon will swoop in to
review it and may provide suggestions or feedback before approving and merging.

Thanks so much for contributing to Akita! ❤️

## When in doubt, don't hesitate to bark at us 🐶

- Email
	- [AkitaFeedback@gmail.com](mailto:AkitaFeedback@gmail.com)
- Find us on DEV.to
	- [esse-dev](https://dev.to/esse-dev)
	- [Elliot](https://dev.to/elliot)
	- [Sharon](https://dev.to/sharon)
- Discord
	- [Akita Discord Server](https://discord.gg/psyNbWW)
- Twitter
	- [Elliot](https://twitter.com/elliotokay)
	- [Sharon](https://twitter.com/_sharonwang)