Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 2.34 KB
Raw

Contributing to Bonita widgets

Table Of Contents

Code of conduct

How to contribute

Styleguide

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to adoption@bonitasoft.com

Report an issue

Bugs, enhancement and new widgets are tracked as GitHub issues. Refer to the GitHub documentation to learn how to use Issues.

Use proper label to categorize the issues:

  • bugs to report a bug
  • enhancement to suggest a code improvement
  • new widget to announce a new widget

Add a new widget

  • Create a new issue in GitHub
  • Create a new folder in the src/widgets. One directory per widget.
  • Tests must be called *.spec.js and located in <widget_folder>/test
  • Widget assets must be in assets directory and declared in widget.json.

Improve existing widget

  • If the improvement or bug fix has no issues associated, create one.
  • Implement the code change

Pull request

  • Each Pull Request have to be linked to an existing GitHub Issue.
  • Follow the Styleguide
  • Make sure your code has sufficient test coverage

Styleguides

The code must be easy to read, be easy to maintain, have enough tests to get confident on its behaviour over time.

AngularJS

The widget code should adhere to AngularJS Standard Style.

Specs

  • Include well-structured Jasmine specs in the <widget_folder>/test folder.
  • Use one describe for your Widget

Documentation

Have a README.md file by widget to describe it:

  • General description to explain what the widget does
  • A chapter to describe how to use the widget
  • A screenshot of the widget displayed