Skip to content

Commit 79d2d92

Browse files
Ataba29Ataba29
authored
Merge pull request #25 from Ataba29/Contributing
Contributing
2 parents 3cd13c1 + ce6de09 commit 79d2d92

12 files changed

Lines changed: 316 additions & 1 deletion

File tree

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Default owners for everything in the repo.
2+
# Replace these usernames with the actual GitHub handles of the maintainers.
3+
* @Ataba @razimograbi

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in ByteForge
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. Please fill out the sections below.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: What happened?
15+
description: A clear description of the bug.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: repro
21+
attributes:
22+
label: Steps to reproduce
23+
description: Minimal steps to reproduce the behavior.
24+
placeholder: |
25+
1. Start the server with ...
26+
2. Send command ...
27+
3. Observe ...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected behavior
35+
validations:
36+
required: true
37+
38+
- type: dropdown
39+
id: platform
40+
attributes:
41+
label: Platform
42+
options:
43+
- Linux
44+
- Windows
45+
- Docker
46+
- Other
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: version
52+
attributes:
53+
label: Commit / version
54+
description: Commit hash or release tag you're running.
55+
validations:
56+
required: false
57+
58+
- type: textarea
59+
id: logs
60+
attributes:
61+
label: Relevant logs / stack trace
62+
render: shell
63+
validations:
64+
required: false

‎.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: Ask a question
4+
url: https://github.com/OWNER/REPO/discussions
5+
about: Use Discussions for general questions instead of an issue.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature Request
2+
description: Suggest an improvement or new feature for ByteForge
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: What problem does this solve?
10+
description: What's missing or painful right now?
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: proposal
16+
attributes:
17+
label: Proposed solution
18+
description: What would you like to see happen?
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Alternatives considered
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
id: context
31+
attributes:
32+
label: Additional context
33+
validations:
34+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
<!-- What does this PR do and why? -->
4+
5+
## Related issue
6+
7+
Closes #
8+
9+
## Type of change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Refactor / internal change
14+
- [ ] Documentation
15+
- [ ] Build / CI
16+
17+
## How was this tested?
18+
19+
<!-- Commands run, platform(s) tested (Linux / Windows / Docker), test cases added -->
20+
21+
## Checklist
22+
23+
- [ ] Code builds locally (`cmake --build build`)
24+
- [ ] Tests pass (`ctest --test-dir build`)
25+
- [ ] Added/updated tests for the change
26+
- [ ] Updated documentation if needed
27+
- [ ] Follows the project's header-guard / .h-.cpp split / Doxygen-comment conventions

‎.github/dependabot.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

‎.github/labeler.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
documentation:
2+
- changed-files:
3+
- any-glob-to-any-file:
4+
- "**/*.md"
5+
- "docs/**"
6+
7+
ci:
8+
- changed-files:
9+
- any-glob-to-any-file:
10+
- ".github/workflows/**"
11+
12+
build:
13+
- changed-files:
14+
- any-glob-to-any-file:
15+
- "CMakeLists.txt"
16+
- "**/CMakeLists.txt"
17+
- "Dockerfile"
18+
19+
tests:
20+
- changed-files:
21+
- any-glob-to-any-file:
22+
- "**/tests/**"
23+
- "**/*test*.cpp"

‎.github/workflows/ci.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-linux:
11+
name: Build & Test (Linux)
12+
runs-on: ubuntu-24.04
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Install Ninja
17+
run: sudo apt-get update && sudo apt-get install -y ninja-build
18+
19+
- name: Configure
20+
run: cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
21+
22+
- name: Build
23+
run: cmake --build build
24+
25+
- name: Test
26+
run: ctest --test-dir build --output-on-failure
27+
28+
build-windows:
29+
name: Build & Test (Windows)
30+
runs-on: windows-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
34+
- name: Install Ninja
35+
run: choco install ninja -y
36+
37+
- name: Configure
38+
run: cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
39+
40+
- name: Build
41+
run: cmake --build build
42+
43+
- name: Test
44+
run: ctest --test-dir build --output-on-failure

‎.github/workflows/labeler.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: "Pull Request Labeler"
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, synchronize, reopened]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
11+
jobs:
12+
label:
13+
runs-on: ubuntu-24.04
14+
steps:
15+
- uses: actions/labeler@v5
16+
with:
17+
repo-token: "${{ secrets.GITHUB_TOKEN }}"

‎.github/workflows/stale.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: "Close stale issues and PRs"
2+
3+
on:
4+
schedule:
5+
- cron: "30 1 * * *"
6+
workflow_dispatch:
7+
8+
permissions:
9+
issues: write
10+
pull-requests: write
11+
12+
jobs:
13+
stale:
14+
runs-on: ubuntu-24.04
15+
steps:
16+
- uses: actions/stale@v9
17+
with:
18+
days-before-stale: 60
19+
days-before-close: 14
20+
stale-issue-message: "This issue has been inactive for 60 days and will be closed in 14 days if there's no further activity."
21+
stale-pr-message: "This PR has been inactive for 60 days and will be closed in 14 days if there's no further activity."
22+
stale-issue-label: "stale"
23+
stale-pr-label: "stale"
24+
exempt-issue-labels: "pinned,in-progress"
25+
exempt-pr-labels: "pinned,in-progress"

0 commit comments

Comments
 (0)