Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 2.29 KB
Raw

Contributing

Versioning

Tthis project adheres to Semantic Versioning.

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Each new version should follow the format, keeping only the title that has some entry

## [1.0.0](../../compare/0.3.0...0.4.0) - 20/12/2017
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security

---

Guiding Principles

  • Changelogs are for humans, not machines.
  • There should be an entry for every single version.
  • The same types of changes should be grouped.
  • Versions and sections should be linkable.
  • The latest version comes first.
  • The release date of each versions is displayed.
  • Mention whether you follow Semantic Versioning.

Types of changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

Vuex State management

Add all states to their own modules inside the folder src/store/modules/ with the custom actions, getters and mutations.

The root actions and getters are intended to interact with more than one module.

Application Structure

├── index.html
├── main.js
├── api
│   └── ... # abstractions for making API requests
├── components
│   ├── App.vue
│   └── ...
└── store
    ├── index.js          # where we assemble modules and export the store
    ├── actions.js        # root actions
    ├── mutations.js      # root mutations
    └── modules
        ├── module1.js    # module1 module
        └── module2.js    # module2 module