From e16b03e6cc0798d6d9a29671837e066c6a5c5484 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Tue, 21 Jul 2015 11:48:00 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6c2c39ca..89bb3a8f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,37 @@ -# Contributing to `next` branch +# Contributing to Semantic UI + +### Usage Questions + +Questions about usage should be asked on [StackOverflow](http://stackoverflow.com/questions/tagged/semantic-ui) or [Gitter](https://gitter.im/Semantic-Org/Semantic-UI). + +Examples of usage questions +* *Why isnt my code working?* +* *Can Semantic UI do this?* + +Once you receive feedback through community channels you may find your question is actually a bug. At this point it's a good idea to submit it as a bug report. Just keep in mind the following suggestions. ### Bugs & Issues -Please submit any bugs you encounter when using the library to our [Github Issues Tracker](https://github.com/Semantic-Org/Semantic-UI/issues). +**Please create a fork of this [jsfiddle](http://jsfiddle.net/efp8z6Ln/) to demonstrate bugs.** + +[Github Issues Tracker](https://github.com/Semantic-Org/Semantic-UI/issues) is used to track all upcoming milestones and changes to the project. When submiting a bug report, please include a set of steps to reproduce the issue and any related information, browser, OS etc. If we can't see the issue then it will make solving things much more difficult. -Please create a fork of this [jsfiddle](http://jsfiddle.net/rduvhn8u/1/) to demonstrate bugs. + +If your bug uses a third party framework like Ember, Meteor, or Angular. Be sure to submit the issue to their respective issues boards. If you are confident the bug is part of the 'vanilla' SUI release, keep in mind not all maintainers are familiar with all framework and a simple test case is greatly appreciated. + +If your bug is reproduced by a maintainer it will be asssigned the [`confirmed bug`](https://github.com/Semantic-Org/Semantic-UI/issues?q=is%3Aopen+is%3Aissue+label%3A%22Confirmed+Bug%22) tag. Browsing this tag is a good way to keep track of known issues with SUI. + + +### Upcoming Releases & Roadmap + +As bugs and features are triaged they will be assigned to milestones. The best indication of when a change will land is to check the date on the [upcoming milestones](https://github.com/Semantic-Org/Semantic-UI/milestones) page. ### Pull Requests +**All pull requests should be merged into the `next` branch.** + Anyone can jump on the issues board and grab off bugs to fix. This is probably the best way to become a contributor to Semantic. Be sure to adhere to the style guides when submitting code. * [Create a Pull Request](https://github.com/Semantic-Org/Semantic-UI/compare)