Webbraket vill bli sveriges största utbildningsresurs för webbutveckling. Det bästa sättet att nå det målet tror vi är att arbeta tillsammans.
Detta är ett projekt för studenter, drivet av studenter. Detta initiativ drivs av en grupp studenter vid Uppsala Universitet men hjälp mottas självklart gladeligen ifrån alla håll och kanter. Om du hittar något som verkar galet så blir vi mer än glada om du skickar en pull request.
Att bidra till Webbraket är inte bara nyttigt för din egen utveckling och ditt CV, utan hjälper även hundratals nya studenter som varje år befattar sig med denna resurs. Om du vill bidra mer regelbundet och bli en del av ett team så läs vidare nedan.
Webbraket drivs av dig och mig. Hittat något som inte verkar stämma? Eller bara vill hjälpa till? Skicka mer än gärna en pull-request. Vänligen följ våra riktlinjer men var inte orolig för att göra fel. Vi hjälps åt :)
Om du undrar mer om någonting som står i denna readme eller känner att du behöver lära dig mer så finns det mycket matnyttig information i vår wiki. Kolla först där och om du inte hittar vad du letar efter, tveka inte, utan kontakta någon av oss.
Starta en ny topic-branch ifrån master. Vänligen följ våra namngivningskonventioner för branches. Du behöver inte squash:a dina commits innan du skickar en PR. Ifall ändringar har skett i master efter att du började arbeta på din branch så får du pluspoäng ifall du rebase:ar.
Vi merge:ar alltid med --no-ff p.g.a. denna artikel.
Vi code-review:ar alla pull-requests för att vi ska kunna hjälpa varandra att utvecklas och bli bättre utvecklare. Kom ihåg att hålla god ton och vara trevliga mot varandra :)
Vi följer i stort sett A successful Git branching model men istället för att använda en separat development-branch eller separata release-branch:es så skickar vi pull requests direkt emot master. Detta gör vi eftersom vi ännu inte upplevt behovet av detta ytterligare steg. Vårt arbetssätt liknar Continuous Integration men det är varje utvecklares ansvar att inte skicka pull requests med "broken code".
Detta är vår "production branch" som alltid innehåller produktionsredo kod. Topic-branches merge:as in i denna branch av core-team. Arbeta aldrig direkt i denna branch.
Denna branch är "deprecated" och bör för nuvarande inte användas. Arbeta således aldrig i denna branch och merge:a aldrig till eller ifrån denna branch.
Denna branch är vår "production server" och förändringar i den reflekteras omgående på webbraket.se. Inget arbeta ska därmed ske direkt i denna branch. Denna branch uppdateras när core team kör publiceringsskriptet ifrån master.
Topic branches används för allt arbete. Vi följer nedan namngivningskonvention.
new/zzzNya features där zzz är ett kort namn på featuren.fix/i111Bug-fix där 111 antingen är ett namn eller issue-numret.big/zzzBranch som förväntas leva längre (såsom e.g. ramverksmigrering).test/zzzAnvänds om du introducerar tester.
Notera att även dessa konventioner gäller för text-uppdateringar. Om du uppdaterar text är det en fix och om du skriver ny text är det en new.
Notera att issue-nummer prefixas med ett i. Detta gör vi för att undvika risker associerade med "bare numbers" i branch-namn. Läs mer här.
Hittat en bugg? Vi använder issues, så om du upptäcker något som verkar vara galet, vill föreslå en ändring, eller någonting helt nytt, skapa gärna en ny issue. Om du kan så får du förstås gärna fixa problemet själv och då istället skicka en pull request.
Detta projekt kräver att node, npm och gulp alla finns tillgängliga i din PATH. Övriga dependencies installeras genom npm och finns alltså specificerade i package.json.
Använd Markdown-syntax i största möjliga mån och undvik ad-hoc-HTML. Eftersom Markdown är väldigt limiterat kommer vi ju tyvärr inte undan. Försök isåfall hålla dig till följande undantag. Om du introducerar nya undantag, vänligen skriv om de här i README:n.
Läs mer om varför vi använder denna stil för blockquotes här.
<figure>
<blockquote>Our universe in the space of possible universes.</blockquote>
<figcaption>Stephen Wolfram, <cite>A New Kind Of Science</cite></figcaption>
</figure>
<figure class="example">
<iframe src="examples/example-name"></iframe>
</figure>
För att skapa den där klassiska lärobokskänslan :) Info-boxen används för by-the-way information, och warning-boxen används för se-upp-notiser.
<div class="box-info"> ... </div>
<div class="box-warning"> ... </div>
Här följer en extremt koncis quickstart för att ge en överblick över vad som krävs för att komma igång med projektet. Men livet är ju sällan så här enkelt :) Så kom ihåg att om du undrar något så konsultera wiki för mer information och/eller kontakta oss.
- Installera git.
- Installera node.
- Installera gulp globalt genom
npm intall -g gulp. - Klona repo:t:
$ git clone git@github.com:webbraket/webbraket.se.git. - Öppna mappen:
$ cd webbraket.se. - Hämta dependecies:
$ npm install. - Starta servern:
$ gulp. - Gå till
http://localhost:8080. - Yay, drink beers :)
Källkod finns i mappen src. Genererad build finns i mappen build (om mappen inte finns så skapas den första gången du bygger projektet genom gulp).
När alla dependencies är installerade är det bara att börja köra tasks. Du kan kolla i gulpfile.js för att närmare undersöka vilka tasks som finns och vad de gör. De mest grundläggande tasks:en finns beskrivna här:
$ gulp
# Alias för `gulp watch:development`
$ gulp watch:development
# Webbserver på http://localhost:8080, bygger till 'build', livereload.
$ gulp watch:production
# Som ovan fast för `production`.
$ gulp build:development
# Bygger till mappen `build` utan att minifiera.
$ gulp build:production
# Bygger till mappen `build` med minifiering.
$ gulp publish
# Publicerar till Github Pages (dvs live). Publicera alltid ifrån master-branch.Webbraket hostas genom Github Pages.
Arbeta i din egen topic-branch. När du är klar med ditt arbeta, pusha din branch och skicka en pull request emot branchen master. Nedan följer ett exempel på en dag i en Webbraket-utvecklares liv :)
$ git clone git@github.com:webbraket/webbraket.se
$ git checkout master
$ git checkout -b new/cat-stories
... do some work ...
$ git add -A
$ git commit -m "Added stories about cats"
$ git push --set-upstream origin new/cat-stories
Vi strävar efter att arbeta så friktionsfritt, demokratiskt och transparent som möjligt. Idéer på hur vi kan bli bättre är alltid välkomna.
Vi arbetar för nuvarande på fyra plan. Vi arbetar med Slack, GitHub:s pull requests/issues, Video calls och med fysiska möten. Projektöverskridande diskussioner sker på Slack, feature/bug-relaterade diskussioner sker på GitHub, och när dessa tekniska plattformar inte räcker till så diskuterar vi frågor vid Video calls eller vid fysiska möten.
Vi använder Slack för projektöverskridande diskussioner. D.v.s. all kommunikation som inte är relaterad till specifika pull requests eller issues. Det är förstås rimligt att använda Slack för att diskutera nya features etc. för att kunna nå koncensus. Men vi ber dig att så fort som möjligt försöka flytta diskussionen till GitHub, eftersom det möjliggör transparens och det blir lättare för utomstående att ge sig in i diskussionen.
Endast core contributors har för nuvarande tillgång till Slack. Detta eftersom det nästan uteslutande är praktiska diskussioner som förs på Slack. Strategiska diskusioner förflyttas så fort som möjligt till öppna fora såsom GitHub. Om du är en del av core contributors men inte har tillgång till Slack. Vänligen kontakta någon i styrelsen.
Varje vecka kör vi ett video-call. För att stärka känslan av gemenskap, men även för att undvika att alla diskussioner ska behöva föras i kommentarsfält. Vi värdesätter demokrati och öppenhet och dessa möten är därför en utmärkt plats att lyfta vad än en har på hjärtat. Moderator för dessa möten är någon i styrelsen.
Dessa möten sker på en regelbunden basis, men listas även i vår gemensamma kalender.
Varje möte börjar som en SCRUM-inspirerad standup. D.v.s. vi tar ett "varv" där alla svarar på de tre frågorna:
- Vad har jag gjort sen senast?
- Vad ska jag göra framöver?
- Vad har jag stött på för problem?
Efter att alla fått svara på de tre frågorna övergår vi till att diskutera övriga agendapunkter som ofta är av en mer strategisk och/eller planerande karaktär.
För att främja transparens kommer dessa möten (med start 2016) att filmas och publiceras på YouTube. För nuvarande filmas mötena ej.
Länkar till vår gemensamma kalender hittar du nedan. Om du vill ha write-access till kalendern vänligen kontakta Christopher.
Ibland kör vi informella och formella fysiska meetups för att främja gemenskapen och för att diskutera viktiga frågor. Dessa möten visas i ovan publika kalender och annonseras/diskuteras först på Slack.
Vi är ett projekt som drivs av ett gäng glada studenter, adjunkter och forskare under Institutionen för informatik och media vid Uppsala universitet.
Om du ska skriva en kandidat-, masteruppsats eller är forskare så är du varmt välkommen att kontakta oss. Vi är en självorganiserad grupp av studenter som producerar öppen källkod, så det finns utrymme för många intressanta möjligheter för forskningsarbeten. Vänligen kontakta i första hand någon i gruppen Styrelsen.
-
2013 HT htmlhunden.se registreras och byggs upp utav Christopher Okhravi och Madelen Hermelin med stöd ifrån Owen Eriksson och Anneli Edman. Målet är att ersätta den tekniska kurslitteraturen i kursen E-tjänster och webbprogrammering.
-
2014 VT htmlhunden.se används bl.a. i kurserna E-tjänster och webbprogrammering samt Multimedia.
-
2014 HT htmlhunden.se används bl.a. i kursen Grundläggande Multimedia.
-
2015 VT htmlhunden.se används bl.a. i kurserna E-tjänster och webbprogrammering samt Multimedia.
-
2015 sommar htmlhunden.se doneras av Christopher och Madelen till det, av samma personer, nystartade projektet Webbraket. Namnbyte sker för att undestryka att detta (1) är ett studentdrivet projekt, samt (2) är ett projekt med holistisk syn på webbutveckling.
Vid tekniska frågor vänligen kontakta någon i Developers. Vid övriga frågor vänligen kontakta Styrelsen. Förslagsvis Christopher.
Nedan följer kort information om Webbraketens styrelse. Styrelsen har rätt att utäva veto i alla frågor. Detta veto ska ej behöva utövas men finns av säkerhetsskäl då Institutionen för informatik och media vid Uppsala universitet stödjer projektet.
- Styrelsen skall alltid bestå av ett ojämnt antal personer, och minst tre.
- Majoriteten av styrelsen skall vara fast anställd vid Uppsala Universitet.
- Förändringar i stadgarna måste godkännas av en majoritet i styrelsen.
- En styrelsemedlem kan endast röstas ut av en majoritet i styrelsen.
- En ny styrelsemedlem måste godkännas av en majoritet av styrelsen.
- Ordförande sitter ett år och väljs på eller nära efterföljande den 1:a Februari.
- Om inga nomineringar eller självnomineringar till ny ordförande har inkommit till den 1:a Februari fortsätter sittande ordförande som ordförande.
- Styrelsemedlemmarnas uppgift är att strategiskt styra, och operationellt möjliggöra organisationens fortlevnad och expansion.
- Christopher Okhravi christopher.okhravi@im.uu.se (ordförande)
- Madelen Hermelin madelen.hermelin@im.uu.se
- John Larsson john.larsson@im.uu.se
Detta projekt är för nuvarande ej vinstdrivet och kostnader täcks av individer i projektet.
Webbraket representerar inte Uppsala universitets åsikter i någon fråga. Projektet drivs ej av Uppsala universitet, utan av studenter antagna på systemvetenskapliga program vid Uppsala universitet och Campus Gotland. Styrelsen består av anställda på Uppsala universitet. Projektet är startat av lärare vid Uppsala universitet och används som utbildningsmaterial i utvalda kurser men bör ses som extern resurs utifrån Uppsala universitets perspektiv.
TODO