diff --git a/README.md b/README.md index 7774264b..6bae93dc 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,89 @@ This is the organisation space for 2024 seminar course. - [Task Force 2024](/admin/taskforces_2024.md) - Use [GitHub Discussion](https://github.com/unibas-tilics/tilics/discussions) for organisational matter. - > You can tag people to notify them to participate in discussion. + - 💡 You can tag people to notify them to participate in discussion. ### For Authors -#### How to create pull request? +#### How to create a pull request + +##### Step 1 : Clone the repository + +Clone the repository to your local machine: + +``` +git clone https://github.com/unibas-tilics/tilics.git +``` + +##### Step 2 : Create a new branch + +Run the following command to create and switch to a new branch: + +``` +git checkout -b +``` + +##### Step 3 : Add your article + +1. Create a folder in the `2024` directory with the same name as your topic (e.g. `/2024/rices_theorem`). +2. Create a Markdown file (exactly named `article.md`) (e.g. `/2024/rices_theorem/article.md`). + - 💡 Please use the template below. **The format is required for making the document more machine-readable.** + + ```markdown + # Put your title here as a first-level header (use `#` sign) + + Put your article's text in Markdown here. + Text before the first second-level header (## Authors) will be included in the final PDF. + + ## Authors + Any text after the first second-level header won't be included in the final PDF. This is useful for adding metadata, such as author information. + - Alice + - Bob + ``` + + - Don't link the illustration image in the markdown file. Instead, put your illustration (exactly named `illustration.svg`) to your article directory (e.g. at `/2024/rices_theorem/illustration.svg`). + + - Commit and push to your previously created branch. + +##### Step 4 : Open a pull request + +Create a pull request from your branch against the `master` branch. Therefore, please click on `New Pull Request` button and add the description of the pull request. + +[Watch the video tutorial](./admin/tooling/create-pull-request.mp4) ### For Quality Team #### How to use labels for tagging? +##### Step 1: Go to the Pull Request + +- Click on the "Pull requests" tab at the top of the page. +- Select the specific pull request you want to review. + +##### Step 2: Locate the Labels Section + +- On the right-hand side of the pull request page, you will see a section labeled **Labels**. + +- Add a Label: + - Click on the **Labels** dropdown. + - A list of available labels will appear. You can choose the appropriate label. + - Click on the desired label(s) to apply them to the pull request. + +- Confirm the Label: + - Once the label(s) is added, it will appear on the right side of the pull request, indicating that the label has been successfully applied. + + +Currently available labels are as follows: + + + #### How to merge pull request? + +##### Step 1 : Review + +- In order to be merged, the pull request requires **two approvals** from the Quality Team. +- Reviewers can add comments in the pull request's comment thread if something should be changed. When editing your article, simply commit and push the changes to your branch, they are automatically added to the pull request. + +##### Step 2 : Merge + +- If everything is ok, the pull request can be merged. Be sure to choose the `Squash and Merge` merge option. diff --git a/admin/taskforces_2024.md b/admin/taskforces_2024.md index 59bf891a..a3728c96 100644 --- a/admin/taskforces_2024.md +++ b/admin/taskforces_2024.md @@ -7,7 +7,7 @@ The spokesperson is marked with a star (*) - Arita Adili - Selaudin Agolli (*) - Fabian Dudler -- Gottfrois.Philippe +- Philippe Gottfrois - Ivan Sulima @@ -21,8 +21,8 @@ The spokesperson is marked with a star (*) ## T / Testing - Liu Chengrui -- Laura Engist -- Andrei Faur (*) +- Laura Engist (*) +- Andrei Faur - Evrim Firatli diff --git a/admin/tooling/create-pull-request.mp4 b/admin/tooling/create-pull-request.mp4 new file mode 100644 index 00000000..557453f1 Binary files /dev/null and b/admin/tooling/create-pull-request.mp4 differ diff --git a/admin/tooling/labels.png b/admin/tooling/labels.png new file mode 100644 index 00000000..5b29bbb0 Binary files /dev/null and b/admin/tooling/labels.png differ diff --git a/renderer/.gitignore b/renderer/.gitignore index ec53a72d..f529ea8f 100644 --- a/renderer/.gitignore +++ b/renderer/.gitignore @@ -8,4 +8,5 @@ svg-inkscape/ *.aux *.log *.pdf -*.out \ No newline at end of file +*.out +*.pdf_tex \ No newline at end of file diff --git a/renderer/Makefile b/renderer/Makefile index 63ca8aa4..bd886cc4 100644 --- a/renderer/Makefile +++ b/renderer/Makefile @@ -16,6 +16,7 @@ endef define process_articles @for dir in $(SRC_DIR)/*/; do \ echo "Processing $$dir..."; \ + rm -f "$${dir}article.tex"; \ pandoc -f markdown -t latex --wrap=preserve --lua-filter=filter.lua "$${dir}article.md" > "$${dir}article.tex"; \ done endef @@ -32,8 +33,8 @@ define create_articles_latex endef -all: $(OUTPUT_PDF).pdf cropped - +all: articles.tex $(OUTPUT_PDF).pdf cropped + @rm -f articles.tex # Main PDF generation $(OUTPUT_PDF).pdf: main.tex intro.tex tilics.cls toc.tex articles.tex diff --git a/renderer/tilics.cls b/renderer/tilics.cls index 0fecec7c..54b3aed9 100644 --- a/renderer/tilics.cls +++ b/renderer/tilics.cls @@ -112,7 +112,8 @@ \newpage \topskip 0pt % Remove any space at the top of the page \vspace*{\fill} % Fill the space above the image - \noindent\hfill\includesvg[width=4in]{#1}\hfill % Center horizontally + \filename@parse{#1}% + \noindent\hfill\includesvg[inkscapepath=svg-inkscape/\filename@area,height=2.5in,width=3.5in]{#1}\hfill % Center horizontally \vspace*{\fill} % Fill the space below the image }