Skip to content

Instantly share code, notes, and snippets.

@vstrimaitis

vstrimaitis/workflow.md

Created September 22, 2017 18:32
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save vstrimaitis/75d7660ff44baa72b75d4528a0324f1f to your computer and use it in GitHub Desktop.
Save vstrimaitis/75d7660ff44baa72b75d4528a0324f1f to your computer and use it in GitHub Desktop.
Download ZIP
vu_hci git+latex workflow proposal
Raw
workflow.md

Git + LaTeX workflow

  • Rašyti kiekvieną (+-) sakinį iš naujos eilutės (eilutės ilgis būtų gerai, jei neviršyt kokių 80 simboli teksto). Gerai todėl, kad git'as skaido tekstinį failą eilutėmis, tai pakeitimai diff'e geriau matytųsi, jei tekstas irgi būtų paskaidytas eilutėm.
  • Paskaidom visą dokumentą į atskirus failus (tarkim po atskirą failą kiekvienam skyriui) ir tada tuos failus pagrindiniam faile įsimetam su \include{file}. Potencialiai sumažintų konflikt riziką ir šiaip skaidymas yra gerai, kaip ir visur.
  • Išnaudokim git'o branch galimybę. Vietoj to, kad visi dirbtų vienu metu ant master branch'o, kiekvienam issue (tarkim) pasikuriam po atskirą branch'a. Kai manom, kad padarėm viską, ko tas issue prašo, galim merge'int į master. Šitas irgi padėtų struktūrizuot darbą ir galbūt padėtų išvengti random merge konfliktų.
  • Dokumento versiją atnaujinam su kiekvienu push'u į master branch'ą. Čia tik šiaip pasiūlymas, bet master'y teoriškai turėtų būt kažkokia daugiau mažiau baigta dokumento versija, todėl būtų logiška būtent ją ir versijuoti.
@vstrimaitis
Copy link
Author

Pastaba dėl \include ir \input gera, kiek dabar skaitau, tai \include daro tą patį, kaip ir \input, tiesiog dar išvalo puslapį. Tai čia jau eigoj turbūt priklausys, ar mum to reiks ar ne.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment