Rád bych přispěl do Nette, ale… FAQ
Otázky a stručné odpovědi pro všechny, kteří by rádi přispěli do Nette Frameworku, ale netuší jak.
Rád bych přispěl do Nette, ale nejsem moc dobrý programátor…
Kód je jen jedna ze šíleně mnoha částí, co tvoří framework. Do Nette mohou přispívat lidé tím, že pomáhají vylepšit dokumentaci, píší články, knihy, korigují naše pokusy o angličtinu, přednáší, točí tutoriály, trpělivě odpovídají na fóru, dělí se o své nápady, programují doplňky, testují nové verze, tvoří pro Nette nástroje, pomáhají s Poslední sobotou, hledají prostory, natáčejí přednášky, stříhají je, organizují a navštěvují hackathony a nebo prostě podporují framework finančně. Určitě existuje ještě dalších 101 věcí, které mě teď nenapadly.
Přispívání do kódu je vlastně jen jedna specifická záležitost, o kterou mi dříve ani tolik nešlo a rozhodně bych nerad vyvolal pocit, že každý by měl přispět řádkem 😉 Podstatné je, že něco dělat chceš, čehož si vážím a dodávám: možností jsou mraky.
Existuje teda nějaký seznam úkolů, které je třeba udělat?
Žádný bodový seznam v tuto chvíli nemám, byť časem třeba něco vznikne. O seznam totiž nejde, inspiraci máš kolem sebe. Třeba když vyřešíš nějaký zajímavý úkol v Nette, máš příležitost o tom blognout (jako to třeba dělá Filip a jiní). Určitě tě mnohokrát napadlo, co by se v Nette mohlo vyřešit líp, netvrď mi, že ne, a to je příležitost napsat RFC (česky: „zlepšovací návrh“).
Ono stačí ve věcech místo problémů vidět příležitosti. Stěžovat si, že Nette nemá zdaleka tolik tutoriálů, co třeba Laravel či Rails versus uvědomit si příležitost a napsat třeba seriál a udělat si tím jméno. Stěžovat si, že v issue trackeru visí bugy versus uvědomit si, že můžu některé vyřešit. Vidět, že mnoho lidí bylo frustrovaných z quickstartu versus uvědomit si možnost s tím něco udělat. A tak dále.
Spíš mám za to, že nevědět, co se žádá, znamená mít klapky na očích.
Dobře, ale pokud chci přímo programovat, musím znát road map
Nejnepraktičtější frameworky jsou ty, které navrhneš tzv. „od stolu“. Nejlepší nápady totiž přicházejí z praxe, když se snažíš něco zjednodušit. Nebo čistě náhodou. Tyhle myšlenky pak tvoří road map.
Sepsal jsem seznam svých idejí, které jsem plánoval do Nette přidat. Mohou tě zaujmout a můžeš se pokusit je realizovat, mohou tě inspirovat k novým nápadům, ale také si jich vůbec nemusíš všímat a můžeš přijít s čímkoliv novým.
Prostě to normálně zkus.
A co když něco naprogramuji a pak to nebude přijato?
To se pochopitelně stát může. Sám jsem naprogramoval stovky věcí, které jsem nakonec do frameworku nedal. Proto je vhodné s nápadem přijít v raném stádium na fórum a sepsat RFC. Odargumentovat nebo si zkusit věc nahrubo naprogramovat často pomůže utřídit myšlenky. Na fóru proběhne diskuse, někdy nelehká, jindy se záměr takřka okamžitě schválí. A domluvili jsme se s kolegy, že budeme RFC věnovat velkou pozornost, aby nevyšuměly.
Někdy není ideální, aby se nápad stal přímo součástí frameworku, ale může z něj být výborný doplněk.
A to musím kvůli všemu psát RFC?
Pochopitelně ne, u jednodušších věcí stačí poslat Pull request (návod). Přičemž kód a commit message musí respektovat coding standards, součástí má být test a nejlépe i zápis do dokumentace.
…což je dost práce. Existuje nějaký nástroj na ověření coding standards?
Poprvé to asi není úplně snadné, ale chceme přece všichni používat framework, který má vysoké nároky na kvalitu, ne? Zvládnout základy Gitu a Githubu se ti milionkrát vrátí. (Btw, dejte prosím Nette hvězdičku!)
Nástroj na ověření coding style zatím nemáme. Osobně mi nechybí: když přispívám do jiných projektů, kód formátuji stejně, jako vypadá ten okolní, v logu se podívám, jak hlavní vývojáři zapisují commit message a je to řádově snazší, než studovat coding standards či instalovat nějaký nástroj. Ale beru, že by se mohl hodit – opět je to příležitost takovou věc udělat.
Jakým způsobem lze psát do dokumentace?
Celá dokumentace je na
Githubu, takže se do ní dá přispívat stejně, jako do kódu, tedy
poslat pull request. Repozitář je rozdělen do větví, dokumentace pro Nette
2.0 je ve větvi doc-2.0
, pro verzi 2.1 v doc-2.1
.
Každou změnu je záhodno udělat v českém i anglickém jazyce. Pro náhled
použijte editor.
Pokud bys chtěl (v angličtině) představit nějaký doplněk nebo publikovat návod, je ti k dispozici i nový Nette Blog.
Proč anglicky? Není trapné mluvit anglicky, když jsme tu samí Češi?
Já vím, ale věc se má tak, že skoro nikdo na světě neumí česky 😉
Na rovinu, angličtina je pravděpodobně mnohem větší problém pro mě, než pro tebe, protože jde o můj pátý jazyk, který se, když jsem byl na základce, ani nevyučoval. Ale bojuji s tím! Psát anglicky má pár výhod: lidi se v diskusích nemají tendenci moc rozkecávat, při psaní se zdokonaluješ ve znalosti nejdůležitějšího jazyka a tvůj článek si může přečíst tisíckrát více lidí.
Kde se dozvím, co se chystá a tak?
Primárním místem je již zmiňovaný Nette Blog + Discussion on development a RFC na fóru. Můžeš sledovat také twitterový účet @NetteFramework či #nettefw a samozřejmě číst tento blog.
Jinak každý měsíc pořádáme Poslední soboty a komornější #NetteFwPivo, kde se pije převážně kubánský rum.
A nemělo by zapadnout, že máme i Youtube kanál s hromadou videí.
A kdo je to „my“?
Skupina samozvaných lidí, kteří prostě chtěli být u toho a chtějí něco dělat. Přidej se!
Btw, pokud jsi napsal nějaký článek, seriál, natočil video apod, bylo by fajn to dát na Planette. Stačí, když mi pošleš odkaz do komentářů, s pár průvodními slovy.
Komentáře
Eda #1
Nebyl by tento článek dobrým kandidátem pro umístění na Nette blog?
Vojtěch Dobeš #2
#1 Edo, Řekl bych, že v české podobě (a kvůli svému zaměření na české vývojáře) spíš na fórum.
enumag #3
„A domluvili jsme se s kolegy, že budeme RFC věnovat velkou pozornost, aby nevyšuměly.“ – Moje RFC si zatím 4 dny vesele šumí. 😛 https://forum.nette.org/…tory-service
Jasně, 4 dny nejsou tak dlouho, ale obvykle po 4 dnech už u RFC nějaká reakce je. Takhle vůbec nevím jestli jsem navrhnul blbost, nebo jestli jsem to napsal moc dlouhé či málo pochopitelné nebo je problém ještě někde jinde. Asi jsem jen příliš nedočkavý.
ad coding standard, mám napsanou tuhle věcičku: https://github.com/…/CodingStyle
Je to ruleset pro PHP CodeSniffer. Někteří (Filip) jej nesnáší, ale svou práci odvádí dobře.
enumag #4
Do „Kde se dozvím, co se chystá a tak?“ je imho vhodné přidat i GH issues.
Honza Lilák #5
Ahoj, na svém blogu jsem psal o tom, jak zobrazit pdf soubory pouze přihlášeným uživatelům: https://web.archive.org/…lum-v-nette/ . Třeba se to bude někomu hodit.
Pavol #6
Chcel by som pomoct s tou anglictinou. Vsimol som si ze oficialne prispevky na fore od Davida maju dost vela chyb. Zijem posledne roky v zahranici a anglictinu mam skoro perfektnu.
Mozte ma niekto dat do kontaktu so spravnou osobou kde by sme mohli dohodnut nejaku formu spoluprace?
Tento článek byl uzavřen. Už není možné k němu přidávat komentáře.