diff --git a/README.md b/README.md index 77e8b609..aee04d26 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,15 @@ 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? + ##### Step 1 : Clone the repository -Clone the repository to your local machine : + +Clone the repository to your local machine: ``` git clone https://github.com/unibas-tilics/tilics.git @@ -30,7 +31,7 @@ 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 : +Run the following command to create and switch to a new branch: ``` git checkout -b @@ -38,78 +39,78 @@ git checkout -b ##### Step 3 : Add your article -Create a folder in the `2024` directory. The name of the folder follows the pattern: `topic-name`, such as `rices-theorem`. +1. Create a folder in the `2024` directory. -Then create a Markdown file `article.md`. Please use the template below and keep the `` and `` lines intact; they are required for making the document more machine-readable. +2. The name of the folder follows the pattern: `topic-name`, such as `rices-theorem`. - ```markdown - -# Put your title here, including the leading pound sign - +3. Then create a Markdown file `article.md`. + - 💡 Please use the template below and keep the `` and `` lines intact. **The format is required for making the document more machine-readable.** - -Put your article's text in Markdown here. - + ```markdown + + # Put your title here, including the leading pound sign + -## Optional text - -If your article has some optional text, add it here. - + + Put your article's text in Markdown here. + -![illustration.png](../articl-topic_name/illustration.png) + ## Optional text + + If your article has some optional text, add it here. + -## Author - -Put your name (and only your name) here. - - ``` + ![illustration.png](../articl-topic_name/illustration.png) -Please put your illustration for the artist(s) to the same directory. + ## Author + + Put your name (and only your name) here. + + ``` -Commit and push to your previously created branch. + - Please put your illustration for the artist(s) to the same directory. -##### Step 4 : Open a pull request + - Commit and push to your previously created branch. -Create a pull request from your branch against the `master` branch. Therefore, please click on "New pull request" and add the description of the pull request. +##### Step 4 : Open a pull request -Here is a reference video. You can click the link and then click "View raw" to download it. -[pull-recreat-video](./create-pull-request.mp4) +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. + ### For Quality Team #### How to use labels for tagging? -```markdown ##### 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: +- 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: + +- 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? -```markdown ##### 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. + +- 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. -``` +- If everything is ok, the pull request can be merged. Be sure to choose the `Squash and Merge` merge option. diff --git a/create-pull-request.mp4 b/admin/tooling/create-pull-request.mp4 similarity index 100% rename from create-pull-request.mp4 rename to admin/tooling/create-pull-request.mp4