Skip to content

Commit

Permalink
Adds first version of the CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
matuella committed Feb 23, 2019
1 parent 3687e4e commit 5b77eb9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How to contribute

There is no rocket science to contributing to this project. Just open your issue or pull request if needed - but please be descriptive!

If this project grows sufficiently, I will create templates for **Pull Request** and **Issue**, so there will be no chaos when dealing with any changes.

To submit a PR, follow [these guidelines](https://gist.github.com/MarcDiethelm/7303312), respect the swiftlint static checks (modifications/exceptions may be discussed), and create an awesome description so we can understand it without asking any whys.

Even though there is no "rules" to how you should contribute, there goes my quick tips on it:

- If you're experiencing a bug that can be demonstrated visually, please take screenshots and post them alongside the issue;
- For a quicker/seamless understanding of the issue, please post a sample project, so the evaluation will be bulletproof;
- This is a git overall tip - do atomic commits with a descriptive message (no more than 50 characters is ideal).

0 comments on commit 5b77eb9

Please sign in to comment.