Skip to content

A starting point for open source software on top of pristine with vue-cli.

License

Notifications You must be signed in to change notification settings

octanolabs/vue-cli-plugin-pristine

Repository files navigation

vue-cli-plugin-pristine

NPM version NPM downloads CircleCI

Pristine project starter for vue-cli.

Inspired by Pristine Typescript React.

How to use Pristine in your vue-cli project

vue create myNewProject
cd ./myNewProject
vue add pristine

Documentation Driven Development

There are many ways to drive open source development. Documenting the problem in the README gives a middle ground between technical and non-technical specifications. This allows organizing solutions to this challenge around community and documentation.

[...] a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.

Conventions and Specifications

Pristine has some strong opinions built in like circleci, semantic-release, npm. So feel free to fork and change it at your own discretion. It is only meant to be a starting point. That being said:

Using conventions, documentation and specifications make it easier to:

  • communicate the problem you are solving
  • ease onboarding
  • build and use composable tools
  • promote open source contribution and engagement
  • promote issue and feature discussion on Github itself

Resources

Getting Started

To get started, fork or duplicate the repository. Then edit this file and delete everything above this line.

Then edit the package.json and change the name and homepage fields to match your newly created repository.

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

About

A starting point for open source software on top of pristine with vue-cli.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published