feat: adding images and GIFS for issues chapter (#53)

open-sauced · Feb 9, 2024 · 5e7fe3b · 5e7fe3b
1 parent 98673dd
commit 5e7fe3b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/assets/failed-automated-tests.png b/assets/failed-automated-tests.png
diff --git a/assets/highlight.gif b/assets/highlight.gif
diff --git a/issues-and-pull-requests.md b/issues-and-pull-requests.md
@@ -100,6 +100,8 @@ If the author does not address the issue or respond to your initial comment, rep
 
 If multiple contributors are failing the same set of tests, then there is a possibility that the tests are flaky or broken and need your attention. In those situations, you want to clarify to the contributor that the failing test is not their fault and will be resolved.
 
+![Failed automated tests img](./assets/failed-automated-tests.png)
+
 ### Spam Pull Requests
 
 There might be times when you will get a spam pull request for your project. In these situations, it is best not to respond to the author. Instead, close it and add a `spam` label on it.
@@ -132,6 +134,8 @@ If you have repeatedly tried to reach out and get no response, you should close
 
 The [Highlights feature](https://docs.opensauced.pizza/features/highlights/) on OpenSauced is a place for you to showcase recent achievements with the open source community. This is a place to introduce your project to potential new contributors and talk about issues that need attention from the community.
 
+![Highlights GIF](./assets/highlight.gif)
+
 ### Issue Highlights
 
 When writing issue highlights, you will want to talk about the issue, how the contributor solved it, and how the solution impacted the project. Once you post a highlight on OpenSauced, re-share it on other platforms like Twitter or LinkedIn for increased visibility. Regularly acknowledging and thanking your contributors, especially in public, will strengthen their loyalty to the project and attract new contributors.