mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

Aperta
#97 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

help wanted
Lingua principale
C++
Stelle
74
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

node-cpp-skel has support for:

  • a .clang-format style file that provides formatting rules (which can be modified/customized)
  • make format an easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)
  • a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by make format)

We can improve by adding docs/recommendations for developers for how to:

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

Individua la documentazione che tratta .clang-format, make format e il controllo della formattazione di Travis. Esamina il riferimento collegato al pre-commit hook e il video sull'integrazione con gli editor, quindi aggiungi raccomandazioni per entrambi i workflow. Il lavoro sarà considerato completato quando gli sviluppatori potranno trovare indicazioni pratiche per configurare un hook di formattazione e configurare gli editor più comuni affinché usino il clang-format installato da Mason.

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

Valutazione

Stack tecnologico
cpp
Ambito
documentation, tooling
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
Mezza giornata
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.