Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sharon-wang committed Jun 13, 2020
1 parent 209b891 commit e6c660a
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# 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/dog-s/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/dog-s/akita/issues/new?assignees=&labels=&template=blank-issue.md&title=)
- 🐞 [Create New Bug Report](https://github.com/dog-s/akita/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D)
- 💡 [Create New Feature Request](https://github.com/dog-s/akita/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE+REQUEST%5D)

## Contribute Code

### 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/dog-s/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/dog-s/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 🐶
- Find us on DEV.to
- [dog-s](https://dev.to/dog-s)
- [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)

0 comments on commit e6c660a

Please sign in to comment.