2023 Meeting Notes

Nakittaja-projektin muistiinpanot

Viikkopalaverit sunnuntaisin klo 10:00 Twig the Code:n Slackissä #nakittajaprojekti-kanavalla

2023-10-01

2023-10-08

2023-10-15

• Henna esitteli yhteisprojekteissa huomitoitavia asioita ja todettiin että näistä asioista ei juurikaan puhuta kursseilla tai kouluissa, vaikka ovat tärkeitä asioita tietää ja ymmärtää
• Keskusteltiin uudesta Learning Git -kirjasta
• Käytiin läpi viime kerran GitHub testailut: Projektirepon sisäinen dokumentointi vs. Wikin käyttö ja Pull Requestin (PR) kokeilu
• Wikissä huomioitavaa, että saman tiedoston editointi samaan aikaan voi aiheuttaa konflikteja
• Wiki käyttäytyy välillä vähän omituisesti, joten ei kannata pelästyä
• VSCoden Markdown lisäosat joita kannattaa käyttää: Markdown All in One ja Markdown Preview Enhanced
• Päätettiin ottaa Figma käyttöön, mutta keskusteltiin myös muista vaihtoehdoista kuten Adobe XD ja Canva.
• Canvan kanssa kannattaa olla tarkkana kuvien lisenssiehdoista, koska jotkut käyttäjistä ovat saaneet laskua perästä
• Scribe on hyvä työkalu step-by-step ohjeiden tekemiseen https://scribehow.com/
• Sovittiin projektille live tapaaminen joulukuulle. Tarkemmat tiedot alempana.
• Jaettiin töitä läsnäolleiden kesken tulevalle syksylle ajatuksena käydä sitten niitä läpi joko viikottaisissa tapaamisissa tai sitten perusteellisemmin joulukuun live tapaamisessa
• Jatkossa miitin alussa sovitaan kirjuri muistiinpanoille
• Projektissa riittää monentasoista hommaa oman kiinnostuksen mukaan, vaikka mukaan liittyisi myöhemminkin!

Githubin suosittelemia yhteisprojektissa huomioitavia asioita

• GitHub Community Standards Checklist: https://github.com/Twig-the-code/nakittaja/community
• ReadMe File: https://github.com/matiassingers/awesome-readme
• Contributor Guidelines: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
• Code of Conduct: https://opensource.guide/code-of-conduct/
• Project License: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository
• Security Policy: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
• Issue & PR Templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
• Wiki: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
• GitHubin oma contribution guide: https://docs.github.com/en/contributing

Muita yhteisprojektissa huomioitavia asioita

• Development styles / Git Workflows / Environment branching: https://www.toptal.com/software/trunk-based-development-git-flow
• GitHub Actions (mm. testien ajot osana pipelineä, release buildaus, automaattinen deployment): https://docs.github.com/en/actions
• Semanttinen versioinumerointi: https://semver.org/
• Change Log: https://github.com/adr/madr/blob/develop/CHANGELOG.md
• Keep a Change Log: https://keepachangelog.com/en/1.0.0/
• Naming Conventions: https://github.com/ktaranov/naming-convention
• Folder structure conventions: https://github.com/kriasoft/Folder-Structure-Conventions
• API naming conventions: https://github.com/RootSoft/API-Naming-Convention
• Branch naming check: https://github.com/nomoapp/branch-naming-check
• Labeling GitHub issues: https://github.com/MunGell/awesome-for-beginners
• Technical Agile Practices (TDD, Parikoodaus, Automaattiset testit,...): https://www.nan-labs.com/expert-guides/agile-technical-practices-guide/
• Agile Technical Practices Distilled: https://leanpub.com/agiletechnicalpracticesdistilled

Open-Source

• Open-Source ohjeistus: https://opensource.guide/starting-a-project/
• Open-Source Project Template: https://github.com/cfpb/open-source-project-template

Design dokumentaatio

• Design dokumentaatio ei ole kovin yleistä open-source projekteissa monestakin syystä: https://www.quora.com/Why-dont-open-source-projects-care-about-the-UI
• Design Docs: https://drive.google.com/drive/folders/1sZX_Yuo0swVT3xr5K-2R-6mG_h5ddDDC
• Figma leiskojen suunnitteluun: https://www.figma.com/

17.12.2023 PROJEKTIN LIVE TAPAAMINEN

• Aika: 17.12.2023 klo 10-17 (lounastauko klo 13-14)
• Paikka: Helsingin keskustakirjasto Oodi, Ryhmätyötila 8
• Sovittiin live tapaamisesta jotta saadaan edistettyä projektia vähän enemmän kerralla
• Käydään läpi selvittelyjen tulokset ja tehdään päätöksiä mitä ja miten projektia tullaan edistämään

Next Steps

• Roosa & Laura: Tutkii millainen olisi hyvä README
• Laura: Pohjustaa Figman projektin käyttöön ja tuo vanhat leiskat sinne pohjaksi
• Henna: Luo teknisen dokumentaation pohjan jotta voidaan jakaa selvittelyjä paremmin
• Henna: Selvittää eri kehittämistyylien aka git workflowien erot
• Noora, Henna & Katja: Tutkii millaisia teknologia vaihtoehtoja (stackejä) olisi tarjolla React Native projektille

Muut asiat

• Twig the Coden vuosikokous ma 30.10.klo 18:00
• Harkinnassa rakentaa hieman laajempi Git-kurssi ensi vuonna

2023-11-12

• Katja esitteli yhdestä omasta React-projektistaan siinä käyttämäänsä kansiorakennetta
• Keskusteltiin haavoittuvuuksista ja niiden korjaamisesta

2023-12-17 LIVE DAY

• typescriptin asennus react native appiin
• branchin luominen
• npm vs. npx
• Committien vs. Pull Requestin (PR) tekeminen
• PR description ohje: Missä filussa, mitä teit ja miksi
• PR:n katselmointi: file change katselmointi VS. lokaalin branchin ottaminen itselle ja tarkastus lokaalisti että tomii
• git pull vs. fetch
• git rebase: VÄLTÄ TÄN KÄYTTÄMISTÄ KUN KYSEESSÄ YHTEISTYÖPROJEKTI
• All: yksi viiva (-a) vs. kaksi viivaa (--all)
• ESLint vs. Prettier vs. Ctrl+Shift+F vs. naming policy
• git branch naming policy: "Add/Fix/Remove/Update/... jotain"
• delete local git branch