From c1480a52ce7eb77ebe67789fbbcf4dbd4a6ada54 Mon Sep 17 00:00:00 2001 From: Aleksander Fidelus <63016446+FidelusAleksander@users.noreply.github.com> Date: Wed, 19 Mar 2025 12:36:33 +0000 Subject: [PATCH 1/3] Add usage examples to README --- README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 75 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 476536a..181de2e 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,83 @@ This repository serves as a comprehensive toolkit for creating and managing GitHub Skills exercises. It provides a collection of tools, templates, and utilities designed to streamline the process of developing educational content for GitHub Skills. -## Contents +### Contents - **[.github/workflows](/.github/workflows)**: GitHub Actions workflows for automating common parts of Skills Exercises - **[markdown-templates](/markdown-templates)**: Ready-to-use Markdown templates for creating consistent exercise documentation, instructions, and README files -## Contributing +## Examples -For contribution guidelines, see our [CONTRIBUTING.md](/CONTRIBUTING.md) file. +### ⚙️ Reusable Workflows + +For a full list of reusable workflows go to the **[.github/workflows](/.github/workflows)** directory. + +#### Starting an exercise + +```yaml +jobs: + start_exercise: + name: Start Exercise + uses: skills/exercise-toolkit/.github/workflows/start-exercise.yml@ + with: + exercise-title: "Introduction to GitHub Copilot" + intro-message: "Let's get you started with GitHub Copilot :robot: ! We will learn ..." + +``` + +#### Finding an exercise + +```yaml + +jobs: + find_exercise: + name: Find Exercise Issue + uses: skills/exercise-toolkit/.github/workflows/find-exercise-issue.yml@ + +``` + + +### 📋 Markdown Templates + +For a full list of markdown templates go to the **[markdown-templates](/markdown-templates)** directory. + +```yaml +steps: + - name: Get markdown templates + uses: actions/checkout@v4 + with: + repository: skills/exercise-toolkit + path: exercise-toolkit + ref: + + - name: Use the template + run: | + cat exercise-toolkit/markdown-templates/step-feedback/checking-work.md + +``` + +Markdown templates are often used together with [skills/action-text-variables](https://github.com/skills/action-text-variables) GitHub Action + +```yaml +steps: + - name: Get markdown templates + uses: actions/checkout@v4 + with: + repository: skills/exercise-toolkit + path: exercise-toolkit + ref: + + - name: Build message - congratulations + id: build-message-congratulations + uses: skills/action-text-variables@v1 + with: + template-file: exercise-toolkit/markdown-templates/readme/congratulations.md + template-vars: | + login=${{ github.actor }} + + - name: Echo updated text + run: echo "$UPDATED_TEXT" + env: + UPDATED_TEXT: ${{ steps.build-message-congratulations.outputs.updated-text }} + +``` From 46cd98d07f953dec449c68288a5a166885f22ede Mon Sep 17 00:00:00 2001 From: Aleksander Fidelus <63016446+FidelusAleksander@users.noreply.github.com> Date: Wed, 19 Mar 2025 12:36:44 +0000 Subject: [PATCH 2/3] Remove contributing file --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 2fb432a..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing to Exercise Toolkit - -Thank you for your interest in contributing to the Exercise Toolkit! This document provides guidelines to help you contribute effectively. From 5969a49c7a74ac386f43646d224c5a582ea51f06 Mon Sep 17 00:00:00 2001 From: Aleksander Fidelus <63016446+FidelusAleksander@users.noreply.github.com> Date: Wed, 19 Mar 2025 12:46:00 +0000 Subject: [PATCH 3/3] Add pull request template --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..26abb94 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +## Changes + + +## Checklist + +- [ ] I have added or updated appropriate labels to this PR +- [ ] I have tested my changes +- [ ] I have updated the documentation if needed