Githawk: Add contributing.md

[BasThomas]

[Sherlouk]

Contributing to GitHawk

This project is continuing to develop rapidly and new features are constantly being added. Pull Requests are accepted but please note that master is constantly changing and your submissions may go stale quick. Be warned!

Setup

In order to compile and run GitHawk locally you will need to provide your own client ID and secret keys from GitHub. You can get these by registering a new OAuth application. The "Authorization callback URL" must be set to freetime://, otherwise you're free to fill it in yourself!

Once you have your client ID and secret you can populate these values into the Secrets.swift file. You should never commit these changes!

Finally you will also need to install apollo-codegen, this is a command line tool which is required to create the GraphQL models! This can be done easily by running npm install.

Pull Requests

All changes should be made off of the latest version of master. If a Pull Request is still being worked on then please make this obvious by including "WIP" in the title!

Pull Requests should have a suitable amount of testing done to ensure it doesn't break the app, and we do appreciate new unit tests being created although this isn't currently enforced in the aim of releasing faster!

Issues

We use GitHub issues in order to track feature requests and bugs! You can raise bugs through the app itself from the Settings page and then tapping "Report a Bug" - this will also include some device specific information to make fixing those bugs a little bit easier!

Beta Testing

We use TestFlight in order to distribute beta versions of this application. If you're interested in helping then DM @_ryannystrom on Twitter with your email address and you'll be added to the list!

License

By contributing to GitHawk, you agree that your contributions will be licensed under the terms found in our LICENSE file. You understand that this project is released, for free, on the iOS App Store.

[BasThomas]

Omg yes! Go for it and open a PR? :)

[BasThomas]

And maybe DM @githawk instead of Ryan

[rnystrom]

Love it. +1 DM @githawk instead, easier to manage. I’ll make sure that account is setup to receive an in DMs.

_{Sent with GitHawk}

[GitHawk]

Please stop mentioning me!

[rnystrom]

Hahahahaha, sorry @GitHawk! If you wanna transfer that username it'll all go away 😇 🙏