sql-js / sql-js/sql.js

CONTRIBUTING.md Guide Lacking "make" Instruction

Aperta
#504 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
13.7k
Fork
1.1k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, sqlite
Ambito
build-system, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.