Permalink
Browse files

Include 'issues' section

  • Loading branch information...
1 parent b647c30 commit 235ec3f45577b0ba421e6c66a76a54ecf2a0dc02 @zenorocha zenorocha committed with eduardolundgren Aug 15, 2013
Showing with 13 additions and 4 deletions.
  1. +13 −4 CONTRIBUTING.md
View
@@ -4,25 +4,34 @@ Over the years, tests and documentation have sometimes been sacrificed in order
As a result, we have instituted new policies related to the tests and documentation which have recently been added to AlloyUI. We would love to share them with you:
-## 1. Code Style
+## 1. Issues
+
+First of all, you should know that we're not using the [GitHub Issues](https://github.com/liferay/alloy-ui/issues), instead we use [Jira](http://issues.liferay.com/browse/AUI). In order for us to help you please check that you've completed the following steps:
+
+* Make sure that you're using the latest version.
+* Look through the list of issues to ensure that the bug hasn't been reported before.
+
+If you're still facing the problem, go ahead and [create an issue](http://issues.liferay.com/secure/CreateIssue!default.jspa). Just remember to include as much information about the bug as possible.
+
+## 2. Code Style
This project uses single-quotes, four space indentation and whitespace around arguments. Please ensure any pull requests follow this closely by using the [EditorConfig file](https://github.com/liferay/alloyui.com/blob/master/.editorconfig) and linting your code with our [JSHint options](https://github.com/liferay/alloyui.com/blob/master/.jshintrc). If you notice existing code which doesn't follow these practices, feel free to shout out and we will change it.
> See [AlloyUI Code Style Guidelines](https://github.com/liferay/alloy-ui/wiki/Code-Style-Guidelines).
-## 2. Tests
+## 3. Tests
No single commit should go to AlloyUI source tree without tests. Exceptions are allowed for some source formatting (like renaming variables or converting spaces to tabs, etc.), but for each bugfix or for each feature added, **tests must be present**.
> See [AlloyUI Testing Guidelines](https://github.com/liferay/alloy-ui/wiki/Testing-Guidelines).
-## 3. Documentation
+## 4. Documentation
All code should be properly documented using [YUIDoc syntax](http://yui.github.io/yuidoc/syntax/index.html). Documentation should be considered as part of the code.
> See [AlloyUI Documentation Guidelines](https://github.com/liferay/alloy-ui/wiki/Documentation-Guidelines).
-## 4. History
+## 5. History
The changes should be described in `HISTORY.md` file which every module has, so it is easy to track which changes have been added between two versions.

0 comments on commit 235ec3f

Please sign in to comment.