Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (33 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

43 lines (33 loc) · 1.29 KB

Contributing

This project should people give an introduction into single page-applications. Furthermore, it should be a reference book for all kinds of features from Sails.js and Vue.js. If you think an important feature is missing, I'm happy about a contribution. Just make sure you fulfill the following points.

General

  • Use JavaScript Standard Style
  • Watch for a clean and readable code style. More here
  • Avoid JavaScript before ES6 wherever possible
  • Run tests with npm run test against Vue.js and Sails.js before commiting
  • Add appropriate tests when adding new features
  • Ideally run npm run build if you change Vue.js related things

For Vue.js frontend tasks, consult the Vue.js Component Style Guide.

Commits

You must follow the given commit schema, which is similar to the Angular one. A linter should warn and prevent you from committing if you don't follow the rules.

type<scope>: message

Where type is one of the following:

'build',
'ci',
'chore',
'docs',
'feat',
'fix',
'perf',
'refactor',
'revert',
'style',
'test'

And scope is either client or server.