developmentseed / developmentseed/seed

seed as a cli tool for managing our repositories

Open
#8 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
17
Forks
2
PR merge metrics
No merged PRs in 30d

Description

> This issue is based on our discussion at the team meeting about creating and upholding standards for our code & repositories

What are our standards for our code and repositories, how do we convey those standards to people we are onboarding, and how do we uphold those standards over time?

To answer those questions we need:
- code & repository best practices at development seed
- guidelines and a checklist for what we should do before releasing/announcing a new project
- ways to easily generate and audit the files of our repositories

We have existing projects that address starting a project:
- project-seed
- python-seed

## We need:
- code quality guidelines
- repo quality guidelines
- `seed` to generate common files and directories of files

## what should a readme include

Some resources:

- [art of readme](https://github.com/noffle/art-of-readme)
- [standard-readme](https://github.com/RichardLitt/standard-readme)

## example repo checklist
- [ ] design doc
- [ ] readme template
- [ ] ci
- [ ] test framework
- [ ] changelog template
- [ ] contributing guidelines

## things we should talk more about:
- there's a difference between small packages, large packages, and the applications we build.
- ways we can better build communities around our work

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.