Skip to content

Commit

Permalink
Merge pull request #62 from dcoull/master
Browse files Browse the repository at this point in the history
Contribution documentation
  • Loading branch information
dcoull committed Mar 7, 2019
2 parents c3d2c82 + 9a23727 commit 59b3795
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing
Take a look at the [issues](https://github.com/rhayes2/CryptBoard/issues) tab to see if there's anything you'd like to work on.
If your idea isn't already on there, feel free to open a new issue!

- Fork CryptBoard into your own repository
- Lick an issue to claim it as your own (or just asked to be assigned it/self assign)
- Clone CryptBoard onto your local machine from the forked repository
- Make incremental commits, it makes it easier to track down bugs if something breaks
- Submit a pull request, referencing the issue number in the commit message

## Coding
- When dealing with UI values (colours, strings etc.) please reference the values stored within the appropriate /res/values/*.xml file as opposed to hard coding. Feel free to fix any hard coded values that were done in a hurry
- Please handle exceptions
- Comment your code so other contributors know what's going on
- Be proud and take credit for your work (also so you can be contacted if there's questions about it down the line)
- Clear up your imports (and feel free to clear up unused imports, cause we're super guilty of not doing that)


## Tutorials
- Write a block comment, or better yet a tutorial in the wiki page for users
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ CryptBoard is a keyboard application for Android devices that allows users to cr


## Contributing
Thanks for your interest in contributing! We welcome many ways to get started; start with our Contributing Guide and then check for open issues for specific tasks.
Thanks for your interest in contributing! We welcome many ways to get started; start with our [Contributing Guide](https://github.com/rhayes/CryptBoard/blob/master/CONTRIBUTING.md) and then check for open [issues](https://github.com/rhayes2/CryptBoard/issues) for specific tasks.

For contributors looking to suggest improvements, feel free to open an issue to start the discussion.

0 comments on commit 59b3795

Please sign in to comment.