Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (34 loc) · 2 KB
Raw

Asking questions

You can ask questions by posting an issue. There is no problem, I'll just add the label question.

However, please follow those simple guidelines before posting:

  1. Describe your issue in an understandable english (english is not my native language, but I still try to write something decent, and so should you).
  2. Please be polite (and occasionally avoid being a beggar... 😒).
  3. Provide a code to illustrate your issue. A plnkr or something alike is better.
  4. Github provides us a wonderful Markdown (text-to-HTML), so use it without restraint, especially when putting your code.
  5. Some really good advices on how to ask question:

Well, that's just some common sense, so it should not be so hard to follow them.

Thank you.

Contributing

  1. Fork this project and install the dependencies:
npm install
  1. Create a new feature/patch branch or switch to the dev branch.
  2. Code your feature/bug fix and live up to the current code standard:
  • Not violate DRY
  • Boy scout rule should be applied
  • The code must be well documented
  • Add tests
  1. Run grunt to build the minified files.
  2. Write a nice commit message.
  3. Pull request using the new feature/patch branch
  4. Ensure the Travis build passes

If you need to see the result of your feature/bug fix on the demo, you can launch the node server by executing the following command and access to http://localhost:3000

grunt serve