sql-js / sql-js/sql.js

CONTRIBUTING.md Guide Lacking "make" Instruction

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

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

主要言語
JavaScript
スター
13.7k
フォーク
1.1k
PR マージ指標
30日以内にマージされた PR はありません

説明

As a non-developer wanting to add FTS-5 support to my own build, I followed the instructions in https://github.com/sql-js/sql.js/blob/master/CONTRIBUTING.md and noted that:

  • step 6 of the Containerized Development Environment (Recommended) section ("Run $ npm test to ensure all tests pass") fails;
  • there is no explicit mention of running make to actually build the distribution assets.

Is there any particular reason why there is no explicit instruction to run make? This would be useful for folk who aren't developers but who may want to make use of a sql.js build with some custom sqlite extensions if there are exact and complete instructions available to do so. (The containerised build really helps in that respect.)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

Start with CONTRIBUTING.md, especially step 6 of the Containerized Development Environment section, and run the documented npm test command to reproduce the reported failure. Check how the containerized build produces distribution assets and document the necessary make step and complete instructions for custom SQLite-extension builds; done means the guide is accurate and users can follow it successfully.

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

評価

技術スタック
javascript, sqlite
領域
build-system, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

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

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