okkur/reposeed

Extensive repository base files up and running in an instant

Extensive repository base files up and running in an instant

NOTE: This is a beta release, we do not consider it completely production ready yet. Use at your own risk.

Reposeed

Start with the base layer necessary to focus on your project and not on the repository.
Licensing, structure, documentation and more boilerplate to get you started from your first commit.

Using Reposeed

Install reposeed via go get.

go get go.okkur.org/reposeed

Create the sample .seed-config.yaml file.

mkdir YOUR-PROJECT
cd YOUR-PROJECT
reposeed init

Change .seed-config.yaml to your needs and apply any changes.

reposeed

Hint: commit any changes you need and stash the rest Take a look at our full documentation.

Support

For detailed information on support options see our support guide.

Helping out

Best place to start is our contribution guide.

---

Code is licensed under the Apache License, Version 2.0.
Documentation/examples are licensed under Creative Commons BY-SA 4.0.
Illustrations, trademarks and third-party resources are owned by their respective party and are subject to different licensing.

The Reposeed logo was created by Florin Luca

---

Copyright 2017 - The Reposeed authors

reposeed's Issues

Add VISION.md

• add vision file
• add vision explanation (nice to scope and direct to on closing out of scope PRs/Issues)

Fix support links + text

• templates
• regenerate seed

Add basic ci for text checks

• https://github.com/amperser/proselint <- some basic check for passive voice, offensive terms etc.
• https://github.com/wooorm/alex

Sidenote: I thought there was some sort of linter to check for the usage of only basic english words between 850-1000 words, but couldn't find it.

Generate ADOPERTS.md file

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently there is no native way to show, who is using the project.

What you expected to happen:
Ability to showcase projects/companies using said project.

Anything else we need to know?:
Example: https://github.com/coredns/coredns/blob/master/ADOPTERS.md

Add version command

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently it is hard to see, which version of reposeed is installed.

What you expected to happen:
Show reposeed version including supported reposeed config versions (currently only v1).

Anything else we need to know?:
Needs #57 first and can be based on the code within github.com/resumic/schema.

Use vanity url

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently our docs use go get github* to install reposeed.

What you expected to happen:
Use vanity urls and use them in the docs.

Consider option for DCO

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently a CLA is used, but various projects moved or are moving to a DCO.
Linux Kernel, Gitlab, Chef etc.

What you expected to happen:
Support or at least consideration of DCOs.

Anything else we need to know?:
Some resources on DCOs:
https://julien.ponge.org/blog/developer-certificate-of-origin-versus-contributor-license-agreements/
https://blog.chef.io/2016/09/19/introducing-developer-certificate-of-origin/
https://about.gitlab.com/2017/11/01/gitlab-switches-to-dco-license/

Move to Cobra CLI tooling

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently our CLI is quite manual.

What you expected to happen:
Move to cobra to get a good default framework for help etc.

Add issue template

Create minimal website with static content

Start with static only and add generator form in second iteration.

Fix linting errors

Is this a BUG REPORT or FEATURE REQUEST?:
bug

What happened:
https://travis-ci.org/okkur/reposeed/jobs/565457236

Add tooling suggestions

• https://krausefx.com/blog/writing-automated-tests-for-your-documentation
• https://github.com/mapbox/retext-mapbox-standard
• https://github.com/btford/write-good

Move generator to cmd/

Add coding style and other guidelines

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Use more inspiration from other guidelines.

Anything else we need to know?:
https://github.com/ciao-project/ciao/blob/master/CONTRIBUTING.md
https://support.mozilla.org/en-US/kb/moderation-guidelines
http://docs.deis.io/en/latest/contributing/standards/#commit-style

Add links and additional guidance in README

• support links
• guidance
• examples + usage
• website/external links

Check flakiness of release and license badges

Is this a BUG REPORT or FEATURE REQUEST?:
bug

What happened:
License and release badges aren't working reliably.

New line issue README licenses

Is this a BUG REPORT or FEATURE REQUEST?:
bug

What happened:
New lines are not added within the license section within the README.

What you expected to happen:
Single line per license note.

• RepoSeed version: master

Don't create seed-config.example.yaml in generated files

Is this a BUG REPORT or FEATURE REQUEST?:
bug

What happened:
We currently create seed-config.example.yaml.

What you expected to happen:
No example file as at this stage a seed config already has to be available.

Iterate on readme

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Readme might still improvable.

Anything else we need to know?:
https://github.com/jehna/readme-best-practices

Add feature request template

• create template
• link template from contributing guide

Add logo

Add MIT license to the README footer conditions

Is this a BUG REPORT or FEATURE REQUEST?:
bug

What happened:
The README defaults to Apache2 even if the mainLicense is MIT in the config.

What you expected to happen:
README use MIT as the license in its footer.

How to reproduce it (as minimally and precisely as possible):
Use MIT as the mainLicense in the seed-config.yaml file.

Anything else we need to know?:

Environment:

• Reposeed version: v0.4.1
• Others:

Additional header examples with other commenting methods

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently only one specific comment style is provided as example license header.

What you expected to happen:
It should give various headers with different commenting styles for different languages.

How to reproduce it (as minimally and precisely as possible):
Try using the current example headers with JS.

Provide hosted version of generator

Expose a http server, which takes json input and generate reposeed files with the templates.
Bundle the generated files and return them.

Logo given as base64 encoded field in json or link instead of just on the filesystem?

Additional licensing for documentation

Add more usage examples to changelog

Add BSD-3 license

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently BSD-3 license is not supported.

What you expected to happen:
BSD-3 license to be supported.

How to reproduce it (as minimally and precisely as possible):
Try running reposeed with BSD-3 license.

Use same structure (subdirectories) for generated files

Add USERS.md file

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What you expected to happen:
Showcase current users. For reposeed itself, but also as template.

Add guidelines for copyright headers

• use year of first addition (don't update to latest year)
• use "by The $PROJECT Authors" to remove focus on corporation or individuals

go get problem

Hi!

This is a bug in the read.me.
I am following the install and get this warning:

Go-> ~/go/src/github.com: go get -v -u github.com/okkur/reposeed/cmd/reposeed/...
github.com/okkur/reposeed (download)
go: warning: "github.com/okkur/reposeed/cmd/reposeed/..." matched no packages
Go-> ~/go/src/github.com: go version
go version go1.12.5 darwin/amd64

This works:

go get -u -v github.com/okkur/reposeed/cmd/...

Don't overwrite existing files without specific overwrite cli flag set.

Additional licensing for illustrations

Embed template files into go binary

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently template files need to be downloaded separately.

What you expected to happen:
Download binary or use go get without worrying about template files.

Anything else we need to know?:
Possible usage of https://github.com/jteeuwen/go-bindata

Automate copying seed config example file.

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently it's necessary to copy the sample config file from a specific GOPATH location.

What you expected to happen:
Provide a reposeed command to simplify that.
reposeed init . <- initialize seed config file in "." directory with sample data.

The sample data should be integrated into the binary via packr and copied into seed-config.yml on the command reposeed init .

Anything else we need to know?:
Rough idea, so happy to get a bit more input.
This would remove the need for knowledge about GOPATH and any manual copying and also makes releasing binaries possible without any manual copy steps.

Copy over issue + PR templates to .gitlab

Makefile to build binary

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently the only way to use it is to use go get.

What you expected to happen:
Ability to run a released binary.

Sidenote:
Might use: https://github.com/thockin/go-build-template

Split out config struct into separate file

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently the config struct is written within the main.go file.

What you expected to happen:
Split out config struct to simplify main.go.

Automate replacement of various variables

• use go template
• add code to generate file via config
• generate reposeed files

Add automation tools from k8s

Move to CODEOWNERS generated OWNERS files

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently we use OWNER files inspired by Kubernetes et al.

What you expected to happen:
Use CODEOWNERS supported by Github.

Anything else we need to know?:
https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

Version config file

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently the config file is not versioned.

What you expected to happen:
Version config file to make migration and upgrade easier in the long run.

Add notes and ideas about funding

• small donation section to start
• further funding ideas in docs/FUNDING.md?
  • donations + transparency
  • corporate sponsorships
  • feature sponsorships
  • support contracts of maintainers
  • merch (stickers, t-shirts)

Work through similar projects for additional lessons

Is this a BUG REPORT or FEATURE REQUEST?:
feature

• https://github.com/nayafia/contributing-template
• https://github.com/LappleApple/feedmereadmes

Iterate templates with latest multi issue templates from Github

Is this a BUG REPORT or FEATURE REQUEST?:
feature

Anything else we need to know?:
https://blog.github.com/2018-01-25-multiple-issue-and-pull-request-templates/

Split up license templates into multiple files

Is this a BUG REPORT or FEATURE REQUEST?:
feature

What happened:
Currently all license templates are cramped into one file.
Harder to maintain and introduces friction.

What you expected to happen:
Splitting it up into one file per license.

How to reproduce it (as minimally and precisely as possible):
Look into the current license template.

[release] 2020-01-23 - v0.4.5

Is this a BUG REPORT or FEATURE REQUEST?:
release

• Update changelog
• Change version
  • /VERSION
  • .seed-config.yaml

---

• Migrate various test/production instances
• tag alpha, beta releases, if necessary
• Fix/document remaining bugs/PRs
• Rinse and repeat

---

• Update docs
• Create final tag
• Create Github release
• Upload Binaries (amd64 currently)
• Upload .sha256
• Copy release notes from changelog

Open for a better repo and org name!

how it compares to cookiecutter

I'm currios how this tool compares to cookiecutter?

I can see that it's written in Go instead of Python, and has significantly different CLI. However, it would be good to know if there is any fundamental difference in philosophy and approach of this tool vs cookiecutter, so that one can tell why they might prefer to use one over the other.

Add example of copyright headers