richard
/
SemanSemantic-UItic-UI
mirror of https://github.com/Semantic-Org/Semantic-UI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge branch 'master' of github.com:Semantic-Org/Semantic-UI

pull/2710/head
jlukic 9 years ago
parent
a93a55399b e16b03e6cc
commit
fe5f524621
2 changed files with 45 additions and 14 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 28
      CONTRIBUTING.md
  2. 31
      README.md

28
CONTRIBUTING.md
View File

@ -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)

31
README.md
View File

@ -13,9 +13,9 @@ Key Features
* Built with EM values for responsive design
* Flexbox friendly
## 2.0 Is Out!
## 2.0 Release
Semantic UI 2.0 is now available. Read up on [what's new](http://www.semantic-ui.com/introduction/new.html) in the docs.
Semantic UI `2.0` is now available. Read up on [what's new](http://www.semantic-ui.com/introduction/new.html) in the docs.
Migration info from `1.x` can be found in the [2.0 release notes](https://github.com/Semantic-Org/Semantic-UI/blob/master/RELEASE-NOTES.md#version-200---march-xx-2015)
@ -26,12 +26,11 @@ Migration info from `1.x` can be found in the [2.0 release notes](https://github
npm install semantic-ui # Use themes, import build/watch tasks into your own gulpfile.
```
Semantic UI includes an interactive installer to help setup your project
![Getting Started](https://dl.dropboxusercontent.com/u/2657007/install.gif)
For details on how work with Semantic theming please [read our theming guide](http://www.semantic-ui.com/usage/theming.html) on [semantic-ui.com](http://www.semantic-ui.com/)
### Usage questions
For usage questions please use [StackOverflow](http://stackoverflow.com/questions/tagged/semantic-ui) or our [Gitter chatroom](https://gitter.im/Semantic-Org/Semantic-UI). [GitHub Issues](https://github.com/Semantic-Org/Semantic-UI/issues) is only for suggesting enhancements and reporting bugs with [test cases](http://jsfiddle.net/efp8z6Ln/).
* For more details on setup visit our [getting started guide](http://semantic-ui.com/introduction/getting-started.html).
* To learn more about theming please read our [theming guide](http://www.semantic-ui.com/usage/theming.html)
#### Additional Versions
@ -53,10 +52,24 @@ Check out our [integration wiki](https://github.com/Semantic-Org/Semantic-UI/wik
* IE 10+
* Android 4
Browser prefixes are present for Internet Explorer 9, but the browser is not officially supported.
Although some components will work in IE9, [grids](http://semantic-ui.com/collections/grid.html) and other [flexbox](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Flexible_boxes) components are not supported by IE9 and may not appear correctly.
## Community
#### Getting Help
Please **do not post** usage questions to GitHub Issues. For these types of questions use [StackOverflow](http://stackoverflow.com/questions/tagged/semantic-ui) or join our [Gitter chatroom](https://gitter.im/Semantic-Org/Semantic-UI).
#### Submitting Bugs and Enhancements
[GitHub Issues](https://github.com/Semantic-Org/Semantic-UI/issues) is for suggesting enhancements and reporting bugs. Before submiting a bug make sure you do the following:
* Check out our [contributing guide](https://github.com/Semantic-Org/Semantic-UI/blob/master/CONTRIBUTING.md) for info on our release cycle
* [Fork this boilerplate JSFiddle](http://jsfiddle.net/efp8z6Ln/) to create a test case for your bug. If a bug is demonstratable from the docs, that's ok as well. Only bugs that include a test case can be triaged.
#### Pull Requests
When adding pull requests be sure to merge into [next](https://github.com/Semantic-Org/Semantic-UI/tree/next) branch. If you need to demonstrate a fix in ``next`` release, you can use [this jsfiddle](http://jsfiddle.net/rduvhn8u/1/)
#### International
* **Chinese** A Chinese mirror site is available at [http://www.semantic-ui.cn](http://www.semantic-ui.cn)
@ -81,10 +94,6 @@ Localization | Help us translate Semantic UI into your language | [Join our Tran
[Angular](https://angularjs.org/) | Help develop angular bindings | Reach Out on [GitHub Issues](https://github.com/Semantic-Org/Semantic-UI-Angular/issues/8)
Guides & Tutorials | Help write guides and tutorials | [Join the discussion](https://github.com/Semantic-Org/Semantic-UI/issues/1571)
#### Pull Requests
When adding pull requests be sure to merge into [next](https://github.com/Semantic-Org/Semantic-UI/tree/next) branch. If you need to demonstrate a fix in ``next`` release, you can use [this jsfiddle](http://jsfiddle.net/rduvhn8u/1/)
#### Reaching Out
If you'd like to start a conversation about Semantic feel free to e-mail me at [jack@semantic-ui.com](mailto:jack@semantic-ui.com)

Write Preview
Loading…
Cancel
Save