Skip to content

Commit 6f51fb5

Browse files
habedihabedi
authored
Add issue templates (#1)
1 parent b5205a7 commit 6f51fb5

File tree

16 files changed

+229
-53
lines changed

16 files changed

+229
-53
lines changed

‎.editorconfig‎

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,24 @@
1-
# EditorConfig is awesome: https://EditorConfig.org
1+
# https://EditorConfig.org
22

3-
# Top-most EditorConfig file
43
root = true
54

6-
# Global settings (applicable to all files unless overridden)
75
[*]
8-
charset = utf-8 # Default character encoding
9-
end_of_line = lf # Use LF for line endings (Unix-style)
10-
indent_style = space # Use spaces for indentation
11-
indent_size = 4 # Default indentation size
12-
insert_final_newline = true # Make sure files end with a newline
13-
trim_trailing_whitespace = true # Remove trailing whitespace
6+
charset = utf-8
7+
end_of_line = lf
8+
indent_style = space
9+
indent_size = 4
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
1412

15-
# C files
1613
[*.{c,h}]
1714
max_line_length = 100
1815

19-
# Markdown files
2016
[*.md]
21-
max_line_length = 120
22-
trim_trailing_whitespace = false # Don't remove trailing whitespace in Markdown files
17+
max_line_length = 150
18+
trim_trailing_whitespace = false
2319

24-
# Bash scripts
2520
[*.sh]
2621
indent_size = 2
2722

28-
# YAML files
2923
[*.{yml,yaml}]
3024
indent_size = 2
31-
32-

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,4 @@
5454

5555
# Exclude files from language stats (GitHub Linguist)
5656
*.ipynb linguist-vendored
57+
Makefile linguist-vendored

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [ habedi ]

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
1.
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Logs**
22+
If applicable, add logs to help explain your problem.
23+
24+
**Additional context**
25+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/CogitatorTech/template-c-project/discussions
5+
about: Please ask and answer general questions here

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/docs.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Publish Doxygen Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
tags:
9+
- 'v*'
10+
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
permissions:
16+
contents: write
17+
18+
jobs:
19+
deploy-docs:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout Repository
23+
uses: actions/checkout@v4
24+
25+
- name: Install Zig
26+
uses: goto-bus-stop/setup-zig@v2
27+
with:
28+
version: '0.15.2'
29+
30+
- name: Install System Dependencies
31+
run: |
32+
sudo apt-get update
33+
sudo apt-get install -y make
34+
35+
- name: Generate Documentation
36+
run: make docs
37+
38+
- name: Deploy to GitHub Pages
39+
uses: peaceiris/actions-gh-pages@v4
40+
with:
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
publish_dir: ./docs/html
43+
publish_branch: gh-pages
44+
user_name: ${{ github.actor }}
45+
user_email: ${{ github.actor }}@users.noreply.github.com
46+
commit_message: "docs: Deploy documentation from ${{ github.sha }} by ${{ github.actor }}"

‎.github/workflows/lints.yml‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1-
name: Run Linters
1+
name: Run Linter Checks
22

33
on:
4-
workflow_dispatch: # Allow manual runs
4+
workflow_dispatch:
55
push:
6+
branches:
7+
- main
68
tags:
7-
- 'v*' # Trigger on version tags
9+
- 'v*'
10+
paths-ignore:
11+
- '**.md'
12+
- 'docs/**'
13+
pull_request:
14+
branches:
15+
- main
16+
paths-ignore:
17+
- '**.md'
18+
- 'docs/**'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
permissions:
25+
contents: read
826

927
jobs:
1028
lint:
@@ -20,5 +38,5 @@ jobs:
2038
sudo apt-get install -y make
2139
make install-deps
2240
23-
- name: Run Linters
41+
- name: Run Linter Checks
2442
run: make lint

‎.github/workflows/tests.yml‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
1-
name: Run Test
1+
name: Run Tests
22

33
on:
4-
workflow_dispatch: # Allow manual runs
4+
workflow_dispatch:
55
push:
6+
branches:
7+
- main
68
tags:
7-
- 'v*' # Trigger on version tags
9+
- 'v*'
10+
paths-ignore:
11+
- '**.md'
12+
- 'docs/**'
13+
pull_request:
14+
branches:
15+
- main
16+
paths-ignore:
17+
- '**.md'
18+
- 'docs/**'
19+
20+
permissions:
21+
contents: read
822

923
jobs:
10-
build:
24+
test:
1125
runs-on: ubuntu-latest
1226

1327
steps:

‎.pre-commit-config.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
default_stages: [ pre-push ]
2+
fail_fast: false
3+
exclude: '(^external/|^docs/)'
4+
5+
repos:
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: v5.0.0
8+
hooks:
9+
- id: trailing-whitespace
10+
args: [ --markdown-linebreak-ext=md ]
11+
- id: end-of-file-fixer
12+
- id: mixed-line-ending
13+
- id: check-merge-conflict
14+
- id: check-added-large-files
15+
- id: detect-private-key
16+
- id: check-yaml
17+
- id: check-toml
18+
- id: check-json
19+
- id: check-docstring-first
20+
- id: pretty-format-json
21+
args: [ --autofix, --no-sort-keys ]
22+
23+
- repo: local
24+
hooks:
25+
- id: format
26+
name: Format Code
27+
entry: make format
28+
language: system
29+
pass_filenames: false
30+
stages: [ pre-commit ]
31+
32+
- id: lint
33+
name: Check Code Style
34+
entry: make lint
35+
language: system
36+
pass_filenames: false
37+
stages: [ pre-commit ]
38+
39+
- id: test
40+
name: Run Tests
41+
entry: make test
42+
language: system
43+
pass_filenames: false

0 commit comments

Comments
 (0)