Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 4.3 KB

CONTRIBUTING.en.md

File metadata and controls

76 lines (50 loc) · 4.3 KB
Raw

Join Amaze UI

We would love for you to contribute to Amaze UI and help make it even better than it is today!

We suggest new contributors to read following articles:

Reporting Bugs

  • Search the Issues and relative comments before submitting a new issue. Probably your issue has been submitted. If this issue has already existed, you may simply add a comment on the former issue. Here are some tips for submitting issues:
  • First check if your issue has been fixed in the latest version;
  • Remove other libraries, and check if the bug is caused by other libraries;
  • Describe the bug in detail, including the OS you were using, the browser you were using and their versions;
  • Add some screen shot if possible.
  • Use online pages to present your issue if possible. We recommend tools like JSBin.

In order to help recreate the bug, we use JSBin to build an online debugging tool. You can paste your code with issue in that tool and send it back to us.

Bug Reporting Template（Click here to use）

**Description**

(Describe your issue)

**Environment**

- Which OS are you using? Which version?
- Which browser are you using? Which version?
- Presentation URL

**How to recreate the bug**

1.
2.
...

Need new functions?

We will try to satisfy all our users resonable need if it is not conflick with our goals and concepts. Please do following things before submitting your need:

  • Visit our website, and make sure that your need is currently not satisfied;
  • Search in Issues and Roadmap, and make sure your need hasn't been submitted by others or in our plan;
  • Make sure your need is not conflict with our concept (Amaze UI is built for modern browsers);
  • Describe your need in detail. Examples are prefered.

Pull Request

Please read Amaze UI coding style before submitting your pull request.

(We are still trying to figure out a standard testing procedure.)

Things where we need your help

  • Let us know your project where you use Amaze UI;
  • Provide support to other CSS extension languages such as SCSS;
  • Develop some template with Amaze UI;
  • Provide support to frameworks like Angular.js, Ember.js, Meteor and etc;
  • Develop Javascript plugins for Amaze UI;
  • Compatibility test. We can only test on several most popular browsers. We hope users can help us test Amaze UI on different user agents;
  • ...

Documents

Development documents are in docs/styleguide, you can also find them in our website: