From 6d126f424435c92fc0c907a8f8f4d534c67986ab Mon Sep 17 00:00:00 2001 From: Waleed Judah Date: Sat, 7 Jun 2025 03:25:57 -0400 Subject: [PATCH] Add CI workflow and templates --- .github/ISSUE_TEMPLATE/bug_report.md | 20 +++++++++++++++++++ .../pull_request_template.md | 5 +++++ .github/workflows/build.yml | 15 ++++++++++++++ README.md | 2 +- 4 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/workflows/build.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3d20f31 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug Report +about: Create a bug report to help us improve +title: "[Bug] " +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment** +- OS: +- Kernel version: diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..65c6f08 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,5 @@ +# Summary +Describe the main changes of this pull request. + +# Testing +Explain how you tested the changes. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..958c1b3 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,15 @@ +name: Build + +on: + push: + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install dependencies + run: sudo apt-get update && sudo apt-get install -y build-essential linux-headers-$(uname -r) + - name: Build modules + run: make diff --git a/README.md b/README.md index 1868b56..6feb1c4 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ non-production environment before deploying on real hardware. ### Contributing 🤝 -Contributions are the cornerstone of this project's growth and success. Whether it's adding new features, fixing bugs, or improving documentation, your help is greatly appreciated. +Contributions are the cornerstone of this project's growth and success. Whether it's adding new features, fixing bugs, or improving documentation, your help is greatly appreciated. When opening an issue, please use the templates in `.github/ISSUE_TEMPLATE`. Pull requests should follow the guidelines outlined in `.github/PULL_REQUEST_TEMPLATE`. ## Support 🤗