improve git instructions

pkeilbach · Dec 22, 2023 · 47bbd04 · 47bbd04
1 parent 76c93a0
commit 47bbd04
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/docs/presentations/presentations.md b/docs/presentations/presentations.md
@@ -84,20 +84,24 @@ This is the preferred way to submit the article. 🤓
  - presentations/presentations.md
  - Articles:
  - Article Template: presentations/articles/template.md
- - <your topic>: presentations/articles/<your topic>.md
+ - <your topic>: presentations/articles/your_topic.md
  ```
 
 3. **Push your changes to the remote repository**
 
  After you have added the article to the repository, you need to push your changes to the remote repository.
 
  ```sh
- git checkout -b presentation-<your topic>
- git add .
+ git checkout -b presentation-your-topic
+ git add docs/presentations/articles/
  git commit -m "Add blog article for <your topic>"
- git push -u origin presentation-<your topic>
+ git push -u origin presentation-your-topic
  ```
 
+ !!! warning
+
+ Please make sure to only add your article and related assets to the commit.
+
 4. **Create a pull request to the `main` branch**
 
  Finally, create a [pull request](https://github.com/pkeilbach/htwg-practical-nlp/pulls) to the `main` branch of the repository.