Pristine project starter for vue-cli.
Inspired by Pristine Typescript React.
vue create myNewProject
cd ./myNewProject
vue add pristine
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.
- Readme Driven Development by Tom Preson-Werner
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
- Pristine
- opensource.guide
- Github community profiles for public repositories
- Readme Driven Development
- pengwynn/flint
- Working Backwards
- Literate programming
- Hammock Driven Development
- Inversion and The Power of Avoiding Stupidity
- choosealicense.com
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.
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.