summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTyler Mauthe <tmauthe@hatsize.com>2015-06-10 18:59:03 -0600
committerTyler Mauthe <tmauthe@hatsize.com>2015-06-10 18:59:03 -0600
commite386ae84d9923e1c82c0441dbe5d9e17e48e0ddc (patch)
treebbe555005144bcb2c721ebccd910776dbaae239a /CONTRIBUTING.md
parentca2dad41cdbfb766028de64b83a1623f2f9e372e (diff)
Squashed commit of the following:
commit 295006bd5ff723e9d79f61584cc645c19b6307d4 Author: Tyler Mauthe <tmauthe@hatsize.com> Date: Wed Jun 10 18:56:20 2015 -0600 :notebook: PR Feedback and normalize formatting commit 28858d2e7cbc59ff285174e0d95e17eccd054b66 Author: Tyler Mauthe <me@tylermauthe.com> Date: Wed Jun 10 00:09:38 2015 -0600 :notebook: Fix formatting and add icon for Docs commit 1557ce16a732e757d905eeb8cb917f6345a2c020 Author: Tyler Mauthe <tmauthe@hatsize.com> Date: Wed Jun 10 00:01:03 2015 -0600 :moyai: Initial Draft of Contribution Guidelines
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d6deb4c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,67 @@
+# Welcome!
+Thank you for your interest in Dashing! This exceptionally handsome
+framework welcomes all input, but being stylish requires certain
+protocols be followed. :bowtie:
+
+Below you will find a set of guidelines that will ensure the best outcome
+for you _and_ Dashing.
+
+<a name="issues"></a>
+## Have an Issue
+If you run into problems with Dashing, please take these steps before
+submitting an issue:
+
+1. Check the [Troubleshooting Guide](https://github.com/Shopify/dashing/wiki#how-tos) in the wiki.
+2. Use the [GitHub Issue Search](https://help.github.com/articles/searching-issues/) to check if the issue has already been reported.
+3. Submit your issue to our Issue Tracker. Please provide as much helpful information as possible, preferably making use of a [reduced test case](https://www.google.ca/search?#q=reduced%20test%20case).
+
+**Support requests should be directed to [Stack Overflow](http://stackoverflow.com/questions/tagged/dashing).**
+
+<a name="features"></a>
+## Feature Requests
+Feature requests are welcome, but take a moment to consider whether your idea
+fits with the scope and aim of the project. A good rule of thumb is to apply
+the 80/20 rule: every feature should be useful to at least 80% of users. Adding
+in every possible edge case will only make it more difficult to understand, maintain,
+and hack on.
+
+If you feel that you have a really amazing, super neato idea that doesn't
+quite fit with the core use of Dashing, it may be a good candidate for an
+external Gem which supercharges a project. An excellent example of this is
+[dashing-contrib](https://github.com/QubitProducts/dashing-contrib). If you
+do create a third-party extension for Dashing, please add it [here](https://github.com/Shopify/dashing/wiki/Additional-Widgets#other-third-party-tools).
+
+<a name="pull-requests"></a>
+## Pull Requests
+
+Patches, improvements and new features are a fantastic
+help -- thank you!
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that may
+not be merged into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+All code submitted via Pull Request will be dicussed and critiqued in a
+respectful manner.
+
+GitHub has [excellent documentation on how to use Pull Requests.](https://help.github.com/articles/using-pull-requests/)
+
+<a name="commit-msgs"></a>
+## Git Commit Message Suggestions
+* Consider starting the commit message with an applicable emoji:
+ * :art: `:art:` when improving the format/structure of the code
+ * :moyai: `:moyai:` when adding a new feature
+ * :wrench: `:wrench:` when dealing with the toolchain (Git, Travis, etc)
+ * :notebook: `:notebook` when dealing with docs
+ * :racehorse: `:racehorse:` when improving performance
+ * :penguin: `:penguin:` when fixing something on Linux
+ * :apple: `:apple:` when fixing something on Mac OS
+ * :bug: `:bug:` when fixing a bug
+ * :bomb: `:bomb:` when removing code or files
+ * :white_check_mark: `:white_check_mark:` when adding tests
+ * :lock: `:lock:` when dealing with security
+ * :arrow_up: `:arrow_up:` when upgrading dependencies
+ * :arrow_down: `:arrow_down:` when downgrading dependencies