https://github.com/octanolabs/pristine-go
A Go open source repository in its original condition.
https://github.com/octanolabs/pristine-go
pristine
Last synced: about 2 months ago
JSON representation
A Go open source repository in its original condition.
- Host: GitHub
- URL: https://github.com/octanolabs/pristine-go
- Owner: octanolabs
- License: mit
- Created: 2019-11-10T21:27:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-05T22:15:02.000Z (over 5 years ago)
- Last Synced: 2023-03-03T04:36:51.832Z (about 3 years ago)
- Topics: pristine
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pristine-go
[](https://circleci.com/gh/octanolabs/pristine-go/tree/master)
A Go open source repository in its original condition.
There are a lack of repositories to start from to build community driven open source projects. Pristine Go is a complete starting point, it follows a Documentation Driven Development approach, and can be used as a resource to augment existing documentation.
## How to use Pristine in your project
There are 3 options for using pristine with your project.
1. Fork this repo as the start of your own, OR
2. [follow these instructions](https://thoughts.t37.net/merging-2-different-git-repositories-without-losing-your-history-de7a06bba804) to use it on an existing repository.
3. Use the `Use this template` button on this repository.
## 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.
- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) by Tom Preson-Werner
### 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
- [Pristine](https://github.com/etclabscore/pristine)
- [opensource.guide](https://opensource.guide/)
- [Github community profiles for public repositories](https://help.github.com/articles/about-community-profiles-for-public-repositories/)
- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
- [pengwynn/flint](https://github.com/pengwynn/flint)
- [Working Backwards](https://www.allthingsdistributed.com/2006/11/working_backwards.html)
- [Literate programming](https://en.wikipedia.org/wiki/Literate_programming)
- [Hammock Driven Development](https://www.youtube.com/watch?v=f84n5oFoZBc)
- [Inversion and The Power of Avoiding Stupidity](https://fs.blog/2013/10/inversion/)
- [choosealicense.com](http://choosealicense.com)
## Getting Started
To get started, [fork](https://help.github.com/articles/fork-a-repo/) or [duplicate](https://help.github.com/articles/duplicating-a-repository/) the repository. Then edit this file and delete everything above this line.
Then execute .pristine/post-install.sh and follow the prompts.
### Contributing
How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.