seed as a cli tool for managing our repositories

オープン
#8 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript

調査の方向性

まず既存の project-seed プロジェクトと python-seed プロジェクトを確認し、次に要求されているコードおよびリポジトリの標準を、この issue の例示チェックリストと比較します。完了条件は、seed CLI のスコープについて合意され、標準が文書化され、生成および監査の動作が定義されていることです。

索引モデルが issue の本文から書いたものです。

説明

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:

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
主要言語
JavaScript
スター
17
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

developmentseed/seed のほかの issue

developmentseed/seed の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。