From e92c999bd17605bba9a331adf0c610bc448c9dc0 Mon Sep 17 00:00:00 2001 From: Shahzada Hatim Date: Sat, 9 Jul 2016 21:08:26 +0200 Subject: Cleaned up shopify references in docs Use consistent naming --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b22e83..33d27a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,7 @@ ## Have an Issue? -Dashing is no longer being actively maintained. - -1. Check the [Troubleshooting Guide](https://github.com/Shopify/dashing/wiki#how-tos) in the wiki. +1. Check the [Troubleshooting Guide](https://github.com/Dashing-io/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. You can ask your issue on the tracker, but your best bet is to go to [Stack Overflow](http://stackoverflow.com/questions/tagged/dashing) @@ -12,5 +10,5 @@ Dashing is no longer being actively maintained. If you feel that you have a really amazing, super neato idea that should be a part 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). +do create a third-party extension for Dashing, please add it [here](https://github.com/Dashing-io/dashing/wiki/Additional-Widgets#other-third-party-tools). -- cgit v1.2.3 From 3d0b97e8feec98bd5f222e325f1c8717ac308832 Mon Sep 17 00:00:00 2001 From: Tyler Mauthe Date: Mon, 26 Sep 2016 09:03:03 -0700 Subject: Update CONTRIBUTING.md --- CONTRIBUTING.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 58 insertions(+), 5 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33d27a6..d6deb4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +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. + -## Have an Issue? +## 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/Dashing-io/dashing/wiki#how-tos) in the wiki. +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. You can ask your issue on the tracker, but your best bet is to go to [Stack Overflow](http://stackoverflow.com/questions/tagged/dashing) +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).** +## 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 should be a part of Dashing, it may be a good candidate for an external Gem which supercharges a project. An excellent example of this is +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/Dashing-io/dashing/wiki/Additional-Widgets#other-third-party-tools). +do create a third-party extension for Dashing, please add it [here](https://github.com/Shopify/dashing/wiki/Additional-Widgets#other-third-party-tools). + + +## 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/) + +## 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 -- cgit v1.2.3 From b1e2589e00197de598215c6504c7714998d3f095 Mon Sep 17 00:00:00 2001 From: Tyler Mauthe Date: Sun, 23 Oct 2016 14:42:17 -0700 Subject: Renamed to Smashing --- CONTRIBUTING.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6deb4c..b7e4dfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,14 @@ # 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. +Thank you for your interest in Smashing! This project is a fork of Dashing, the exceptionally handsome dashboard framework. We're still in the process of transitioning, so please excuse the mess. ## Have an Issue -If you run into problems with Dashing, please take these steps before +If you run into problems with Smashing (or 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. +1. Check the [Troubleshooting Guide](https://github.com/Dashing-io/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).** +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://developer.mozilla.org/en-US/docs/Mozilla/QA/Reducing_testcases). ## Feature Requests @@ -26,10 +19,10 @@ in every possible edge case will only make it more difficult to understand, main 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 +quite fit with the core use of Smashing, 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). +do create a third-party extension for Smashing, please add it [here](https://github.com/Dashing-io/dashing/wiki/Additional-Widgets#other-third-party-tools). ## Pull Requests -- cgit v1.2.3 From b6a5149d02533d755c898239bcae2c8f034714bb Mon Sep 17 00:00:00 2001 From: "Bruno P. Kinoshita" Date: Sat, 17 Dec 2016 09:59:33 +1300 Subject: Add mailing list to contributing --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7e4dfe..dd4e478 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,15 @@ # Welcome! + Thank you for your interest in Smashing! This project is a fork of Dashing, the exceptionally handsome dashboard framework. We're still in the process of transitioning, so please excuse the mess. +For general questions on new features, widgets, or ideas, please consider using the +[project mailing list](https://groups.google.com/forum/#!forum/smashing-dashboard). This way +developers can maintain code-related issues in GitHub, and help users with users with simple +usage or widgets questions in a more appropriate channel. + ## Have an Issue + If you run into problems with Smashing (or Dashing), please take these steps before submitting an issue: @@ -12,6 +19,7 @@ submitting an issue: ## 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 @@ -24,6 +32,9 @@ 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 Smashing, please add it [here](https://github.com/Dashing-io/dashing/wiki/Additional-Widgets#other-third-party-tools). +For general questions on new features, widgets, or ideas, please use the +[project mailing list](https://groups.google.com/forum/#!forum/smashing-dashboard). + ## Pull Requests @@ -44,6 +55,7 @@ GitHub has [excellent documentation on how to use Pull Requests.](https://help.g ## 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 -- cgit v1.2.3 From d5ae8dadee453232921fc27433b3de449cfc0a64 Mon Sep 17 00:00:00 2001 From: Tyler Mauthe Date: Sun, 15 Jan 2017 10:27:53 -0800 Subject: Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd4e478..051a840 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Thank you for your interest in Smashing! This project is a fork of Dashing, the exceptionally handsome dashboard framework. We're still in the process of transitioning, so please excuse the mess. For general questions on new features, widgets, or ideas, please consider using the -[project mailing list](https://groups.google.com/forum/#!forum/smashing-dashboard). This way +[Gitter Chat Room](https://gitter.im/Smashing/Lobby). This way developers can maintain code-related issues in GitHub, and help users with users with simple usage or widgets questions in a more appropriate channel. -- cgit v1.2.3