diff --git a/reglemente/README.md b/README.md similarity index 51% rename from reglemente/README.md rename to README.md index f051fc3..8d5a5a3 100644 --- a/reglemente/README.md +++ b/README.md @@ -1,25 +1,24 @@ -# Reglemente +# Styrdokument -Detta är reglementet för D-sektionen inom TLTH. Under "Releases" finns alla versioner av reglementet. Läs commit-meddelanden för en mer detaljerad historik. +Det här är repot för D-sektionen inom TLTH:s styrdokument. Under "Releases" finns alla versioner av styrdokumenten sedan de separata repona fördes samman. Läs commit-meddelanden för en mer detaljerad historik. ## Användning All text i repot ska vara skrivet på svenska. ### Efter ett sektionsmöte * Klona repot. `git clone https://github.com/Dsek-LTH/reglemente.git` -* Om du redan klonat det, se till att du är på senaste revisionen. `git checkout master && git pull` -* Skapa en ny branch. `git checkout -b [branchnamn, tex HTM2-2019]` +* Om du redan klonat det, se till att du är på senaste revisionen. `git checkout main && git pull` +* Skapa en ny branch. `git checkout -b ` * För varje motion och proposition: - * Ändra main.tex på det sätt som krävs för den nya motionen eller propositionen. - * Efter varje införd ändring skapa en commit med ett meddelande innehållande mötesförkortningen och ändringen. `git commit -m "[HTM2 2018] La till nya åligganden under Staben"` + * Ändra i dokumenten på det sätt som krävs för den nya motionen eller propositionen. + * Efter varje införd ändring skapa en commit med ett meddelande innehållande mötesförkortningen och ändringen. `git commit -m "[HTM2 2019] Lade till nya åligganden under Staben"` * Om en mer detaljerad beskrivning behövs bör kroppen av commitens meddelande istället användas. `git commit` -* Se till att att mötesnamn och dagens datum står på varje sida i reglementet högst upp i högra hörnet. -* Pusha upp din branch till Github. `git push -u origin [branchnamn, tex HTM2-2019]` +* Pusha upp din branch till Github. `git push -u origin ` * Öppna en pull request på https://github.com/Dsek-LTH/reglemente/pulls för att få med dina ändringar till huvudbranchen. -* När denna godkänts skapas en ny release och PDF automatiskt. +* När denna godkänts skapas en ny release och PDF:er automatiskt. ### När du vill göra redaktionella ändringar -Redaktionella ändringar ändrar inte betydelsen av reglementet, utan ändrar enbart läsbarheten eller rättar små uppenbara fel. För att skapa en redaktionell ändring, följ instruktionerna för "Efter ett sektionsmöte" med undantag för att commit-meddelandet inte ska innehålla en mötesförkortning utan istället [Redaktionella ändringar]. `git commit -m "[Redaktionella ändringar] Fixade stavfel"`. Döp gärna branchen till något i stil med "redaktionellaandringar". +Redaktionella ändringar ändrar inte betydelsen av dokumenten, utan ändrar enbart läsbarheten eller rättar små uppenbara fel. För att skapa en redaktionell ändring, följ instruktionerna för "Efter ett sektionsmöte" med undantag för att commit-meddelandet inte ska innehålla en mötesförkortning utan istället [Redaktionella ändringar]. `git commit -m "[Redaktionella ändringar] Fixade stavfel"`. Döp gärna branchen till något i stil med "redaktionellaandringar". ### När du vill göra ändringar till repot Ändringar som inte påverkar reglementet direkt, så som ändringar av continuous integration eller README-filen, ska inte innehålla en mötesförkortning utan istället [Repoändringar]. `git commit -m "[Repoändringar] Uppdaterade README"`. Döp gärna branchen till något i stil med "repoandringar" @@ -27,5 +26,4 @@ Redaktionella ändringar ändrar inte betydelsen av reglementet, utan ändrar en ## Historik Vid höstterminsmöte 1 2017 togs ett beslut att införa historik för sektionens styrdokument. Det togs även ett beslut att ålägga styrelsen att retroaktivt i den mån det går att införa denna historik. Detta påbörjades genom att i början i styrdokumenten fylla i en tabell med: datum, möte som tog beslutet, motion och vad som ändrades i klartext. Detta var inte hållbart i längden och Styrelsen 2019 flyttade hantering av historiken till Github. Den tidigare historiken ligger i en tidigt commit kallad "tidigare historik". De första ändringarna till styrdokumenten Github användes för var besluten från höstterminsmöte 2 2018. -## Autoformatering -Inbyggt i de flesta tex installationer finns programmet `latexindent` medföljande. Genom att köra `latexindent main.tex -w` för att se till att formateringen blir korrekt. Om du får varningar om att du saknar perl-paket när du kör `latexindent --version`, testa att köra `sudo cpan Log::LogDispatch Log::Dispatch::File YAML::Tiny File::HomeDir Log::Log4perl Unicode::GCString Getopt::Long` för att installera dessa. +Från 2019 till 2024 användes separata repon för [stadgar](https://github.com/Dsek-LTH/stadgar), [reglemente](https://github.com/Dsek-LTH/reglemente), [policyer](https://github.com/Dsek-LTH/policys) och [riktlinjer](https://github.com/Dsek-LTH/riktlinjer). Detta var omständigt och gjorde ändringar svårare att följa. Sommaren 2024 konsoliderades repona till det du ser framför dig. diff --git a/policyer/README.md b/policyer/README.md deleted file mode 100644 index 25af5bc..0000000 --- a/policyer/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Policys - -Detta är D-sektionen inom TLTHs policys. Under "Releases" finns alla versioner av policys sedan HTM1 2020. Om man följer commit-meddelanden finns mer detaljerad historik. - -## Användning - -All text i repot ska vara skrivet på svenska. - -### Efter ett sektionsmöte eller styrelsemöte - -- Klona repot. `git clone https://github.com/Dsek-LTH/policys` -- Om du redan klonat det till att du är på senaste revisionen. `git checkout master && git pull` -- Skapa en ny branch. `git checkout -b [branchnamn, tex HTM1-2020]` -- För varje motion och proposition: - - Ändra policyns tex-fil på det sätt som krävs för den nya motionen eller propositionen. - - Efter varje införd ändring skapa en commit med meddelande innehållande mötesförkortningen för mötet och ändringen. `git commit -m "[HTM1 2020] La till valberedningsrepresentant i tackpolicyn"` eller `git commit -m "[S19 2020] Skapade bilpolicy"` - - Om en mer detaljerad beskrivning behövs bör kroppen av commitens meddelande istället användas. `git commit` -- Se till att uppdatera policyns historik. Det vill säga om den har uppdaterats på ett styrelsemöte så lägg till vilket möte det var. Samma sak gäller för sektionsmöte. Finns ingen historik för policyn, så skapa en. -- Pusha upp din branch till Github `git push -u origin [branchnamn, tex HTM1-2020]` -- Öppna en pull request på https://github.com/Dsek-LTH/policys/pulls för att få med dina ändringar till huvudbranchen. -- När denna godkänts så ska en ny release och PDF automatiskt skapas. Om det inte sker automatisk så ska man göra en egen release. Glöm i så fall inte att lägga till alla byggda pdf:er, inte bara de uppdaterade. - -### När du vill göra redaktionella ändringar - -Redaktionella ändringar ändrar inte betydelsen av en policy, utan ändrar enbart läsbarheten eller rättar små uppenbara fel. För att skapa en redaktionell ändring, följ instruktionerna för "Efter ett sektionsmöte" utöver att commit-meddelandet ska inte innehålla en mötesförkortning utan istället [Redaktionella ändringar]. `git commit -m "[Redaktionella ändringar] Fixade stavfel"`. Döp gärna branchen till något i stil med "redaktionellaandringar". - -### När du vill ändringar till repot - -Ändringar som inte påverkar policys direkt så som ändringar av continuous integration, README-filen eller lägga till/ta bort en policy ska inte innehålla en mötesförkortning utan istället [Repoändringar]. `git commit -m "[Repoändringar] Ändrade README"`. Döp gärna branchen till något i stil med "repoandringar". - -### Dokumentklasser och packages - -För att kunna bygga dokumenten behöver du ha D-seks latexfiler installerade på lämpligt ställe. [Du hittar det här](https://github.com/Dsek-LTH/dsek-latex) diff --git a/riktlinjer/README.md b/riktlinjer/README.md deleted file mode 100644 index cb4ebf2..0000000 --- a/riktlinjer/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Riktlinjer - -Detta är D-sektionen inom TLTHs riktlinjer. Under "Releases" finns alla versioner av riktlinjer sedan HTM1 2020. Om man följer commit-meddelanden finns mer detaljerad historik. - -## Användning - -All text i repot ska vara skrivet på svenska. - -### Efter ett sektionsmöte eller styrelsemöte - -- Klona repot. `git clone https://github.com/Dsek-LTH/riktlinjer` -- Om du redan klonat det till att du är på senaste revisionen. `git checkout master && git pull` -- Skapa en ny branch. `git checkout -b [branchnamn, tex HTM1-2020]` -- För varje motion och proposition: - - Ändra policyns tex-fil på det sätt som krävs för den nya motionen eller propositionen. - - Efter varje införd ändring skapa en commit med meddelande innehållande mötesförkortningen för mötet och ändringen. `git commit -m "[HTM1 2020] La till valberedningsrepresentant i tackpolicyn"` eller `git commit -m "[S19 2020] Skapade bilpolicy"` - - Om en mer detaljerad beskrivning behövs bör kroppen av commitens meddelande istället användas. `git commit` -- Se till att uppdatera policyns historik. Det vill säga om den har uppdaterats på ett styrelsemöte så lägg till vilket möte det var. Samma sak gäller för sektionsmöte. Finns ingen historik för policyn, så skapa en. -- Pusha upp din branch till Github `git push -u origin [branchnamn, tex HTM1-2020]` -- Öppna en pull request på https://github.com/Dsek-LTH/riktlinjer/pulls för att få med dina ändringar till huvudbranchen. -- När denna godkänts så ska en ny release och PDF automatiskt skapas. Om det inte sker automatisk så ska man göra en egen release. Glöm i så fall inte att lägga till alla byggda pdf:er, inte bara de uppdaterade. - -### När du vill göra redaktionella ändringar - -Redaktionella ändringar ändrar inte betydelsen av en policy, utan ändrar enbart läsbarheten eller rättar små uppenbara fel. För att skapa en redaktionell ändring, följ instruktionerna för "Efter ett sektionsmöte" utöver att commit-meddelandet ska inte innehålla en mötesförkortning utan istället [Redaktionella ändringar]. `git commit -m "[Redaktionella ändringar] Fixade stavfel"`. Döp gärna branchen till något i stil med "redaktionellaandringar". - -### När du vill ändringar till repot - -Ändringar som inte påverkar riktlinjer direkt så som ändringar av continuous integration, README-filen eller lägga till/ta bort en policy ska inte innehålla en mötesförkortning utan istället [Repoändringar]. `git commit -m "[Repoändringar] Ändrade README"`. Döp gärna branchen till något i stil med "repoandringar". - -### Dokumentklasser och packages - -För att kunna bygga dokumenten behöver du ha D-seks latexfiler installerade på lämpligt ställe. [Du hittar det här](https://github.com/Dsek-LTH/dsek-latex) diff --git a/stadgar/README.md b/stadgar/README.md deleted file mode 100644 index df2bb31..0000000 --- a/stadgar/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# Stadgar - -Detta är D-sektionen inom TLTHs stadgar. Under "Releases" finns alla versioner av stadgarna och om en följer commit-meddelanden finns mer detaljerad historik. - -## Användning -All text i repot ska vara skrivet på svenska. - -### Efter ett sektionsmöte -* Klona repot. `git clone https://github.com/Dsek-LTH/stadgar` -* Om du redan klonat det till att du är på senaste revisionen. `git checkout master && git pull` -* Skapa en ny branch. `git checkout -b [branchnamn, tex HTM2-2019]` -* För varje motion och proposition: - * Ändra main.tex på det sätt som krävs för den nya motionen eller propositionen. - * Efter varje införd ändring skapa en commit med meddelande innehållande mötesförkortningen för mötet som gjorde andra läsningen och ändringen. `git commit -m "[HTM2 2018] Bytte sektionens Hymn"` - * Om en mer detaljerad beskrivning behövss bör kroppen av commitens meddelande istället användas. `git commit` -* Se till att att mötesnamn och dagens datum står på varje sida i stadgarna högst upp i högra hörnet. -* Pusha upp din branch till Github `git push -u origin [branchnamn, tex HTM2-2019]` -* Öppna en pull request på https://github.com/Dsek-LTH/stadgar/pulls för att få med dina ändringar till huvudbranchen. -* När denna godkänts, skapas en ny release och PDF automatiskt. - -### När du vill göra redaktionella ändringar -Redaktionella ändringar ändrar inte betydelsen av stadgarna, utan ändrar enbart läsbarheten eller rättar små uppenbara fel. För att skapa en redaktionell ändring, följ instruktionerna för "Efter ett sektionsmöte" utöver att commit-meddelandet ska inte innehålla en mötesförkortning utan istället [Redaktionella ändringar]. `git commit -m "[Redaktionella ändringar] Fixade stavfel"`. Döp gärna branchen till något i stil med "redaktionellaandringar". - -### När du vill ändringar till repot -Ändringar som inte påverkar stadgarna direkt så som ändringar av continuous integration eller README-filen ska inte innehålla en mötesförkortning utan istället [Repoändringar]. `git commit -m "[Repoändringar] Uppdaterade README"`. Döp gärna branchen till något i stil med "repoandringar" - -## Historik -Vid höstterminsmöte 1 2017 togs ett beslut att införa historik för sektionens styrdokument. Det togs även ett beslut att ålägga styrelsen att retroaktivt i den mån det går att införa denna historik. Detta påbörjades genom att i början i styrdokumenten fylla i en tabell med: datum, möte som tog beslutet, motion och vad som ändrades i klartext. Detta var inte hållbart i längden och Styrelsen 2019 flyttade hantering av historiken till Github. Den tidigare historiken ligger i en tidigt commit kallad "tidigare historik". De första ändringarna till styrdokumenten Github användes med var besluten från höstterminsmöte 2 2018.