Skip to content

Latest commit

 

History

History
56 lines (28 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

56 lines (28 loc) · 2.19 KB

Contributing to the Bakery App Starter

First off, thanks for taking the time to contribute!

The following is a set of guidelines to make cooperation between different individuals smooth and efficient. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Ways to contribute

Styleguides

Ways to contribute

Reporting Bugs

Please report bugs by opening issues with the bug label in project's GitHub repo.

When reporting a bug, please make sure to provide enough details and context so that the development team can reproduce the issue and understand what is the expected behavior.

Suggesting Enhancements

Please suggest enhancements by opening issues with the enhancement label in project's GitHub repo.

When reporting a bug, please make sure to provide enough background for your use case and a clear description of what is expected.

Making Pull Requests

When making pull requests please make sure to follow the styleguides.

Styleguides

Java Styleguide

Tabs for indentation.

This repo follows the Eclipse Oxygen defaults for Java code.

JavaScript and CSS Styleguide

Two spaces for indentation.

This repo uses ESLint for linting JavaScript code and stylelint for linting CSS. You can check if your code is following our standards by running npm run lint inside the src/main/frontend folder. It will automatically lint all .js and .css files, as well as <style> and <script> tags inside .html files.

The ESLint and stylelint configs are the same as in the Vaadin Core Elements repo.