Skip to content

Commit dd4eb61

Browse files
committed
Added a bunch of Docs and Issue templates and CODEOWNERS
1 parent 30daf02 commit dd4eb61

11 files changed

Lines changed: 298 additions & 226 deletions

File tree

.github/CODEOWNERS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Default owners for the whole repository
2+
* @TheCodeVerseHub/core
3+
4+
# Area ownership (keep these lightweight and practical)
5+
/docs/ @TheCodeVerseHub/core
6+
/scripts/ @TheCodeVerseHub/core
7+
/configs/ @TheCodeVerseHub/core
8+
/iso/ @TheCodeVerseHub/core
9+
/pkgbuild/ @TheCodeVerseHub/core
10+
/src/ @TheCodeVerseHub/core
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug report
2+
description: Report something that is broken or unexpected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug.
9+
10+
- type: input
11+
id: version
12+
attributes:
13+
label: ISO/version
14+
description: If known (e.g. iso_version from the boot screen, or the build date)
15+
placeholder: "2026.03.29 (example)"
16+
validations:
17+
required: false
18+
19+
- type: dropdown
20+
id: environment
21+
attributes:
22+
label: Environment
23+
options:
24+
- VM
25+
- Real hardware
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: what_happened
31+
attributes:
32+
label: What happened?
33+
description: A clear and concise description of the problem
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: steps
39+
attributes:
40+
label: Steps to reproduce
41+
placeholder: |
42+
1. Boot ISO
43+
2. Run cvh-install
44+
3. ...
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected behavior
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: logs
57+
attributes:
58+
label: Logs / output
59+
description: Paste relevant output (journalctl, installer output, etc.)
60+
render: shell
61+
validations:
62+
required: false
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Feature request
2+
description: Suggest an idea or improvement
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping improve CVH Linux.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem / motivation
14+
description: What problem does this solve?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: Proposed solution
22+
description: What would you like to see implemented?
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternatives considered
30+
validations:
31+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Summary
2+
3+
<!-- What does this PR do and why? -->
4+
5+
## Changes
6+
7+
-
8+
9+
## Testing
10+
11+
<!-- How did you test this? -->
12+
- [ ] Built ISO
13+
- [ ] Booted in VM
14+
- [ ] Ran installer (`cvh-install`)
15+
16+
## Checklist
17+
18+
- [ ] Scope is focused (no unrelated changes)
19+
- [ ] Docs updated (if needed)
20+
- [ ] Scripts/configs changed were tested

CONTRIBUTING.md

Lines changed: 28 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,45 @@
1-
# Contributing to CodeVerse Hub Projects
1+
# Contributing
22

3-
Thank you for your interest in contributing to CodeVerse Hub projects.
4-
All repositories under the CodeVerse Hub organization are community-driven and open to contributions.
3+
Thanks for contributing to CodeVerse Linux (CVH Linux).
54

6-
This document explains how to get started and what is expected from contributors.
5+
## Setup (build environment)
76

8-
---
7+
This project builds an ArchISO and is easiest to work on from an **Arch-based host**.
98

10-
## Who Can Contribute
9+
Required tools for ISO builds:
1110

12-
- Beginners, intermediate, and advanced developers
13-
- Designers, writers, and documentation contributors
14-
- Anyone willing to collaborate respectfully
11+
- `archiso` (provides `mkarchiso`)
12+
- `squashfs-tools` (provides `mksquashfs`)
13+
- `libisoburn` (provides `xorriso`)
14+
- `grub` (provides `grub-mkrescue`)
1515

16-
You do not need prior open-source experience.
16+
Install (Arch):
1717

18-
---
18+
- `sudo pacman -S archiso squashfs-tools libisoburn grub`
1919

20-
## How to Start
20+
If you touch `src/` (Rust tools), install Rust via rustup.
2121

22-
1. Choose a repository under the organization
23-
https://github.com/TheCodeVerseHub
24-
2. Read the repository README carefully
25-
3. Check existing issues
26-
4. Pick an issue or open a new one if needed
27-
5. Fork the repository
28-
6. Create a new branch for your work
29-
7. Make your changes
30-
8. Submit a pull request
22+
## Common tasks
3123

32-
---
24+
- Build packages: `./scripts/build-packages.sh`
25+
- Build ISO: `./scripts/build-iso.sh`
3326

34-
## Development Workflow
27+
More detail: [docs/BUILD.md](docs/BUILD.md).
3528

36-
- Fork the repository
37-
- Create a branch using a clear name
38-
Example: `fix-starboard-bug` or `add-hyprland-config`
39-
- Keep commits small and meaningful
40-
- Write clear commit messages
41-
- Test your changes before submitting
29+
## Testing changes
4230

43-
---
31+
Recommended: test in a VM first.
4432

45-
## Pull Request Guidelines
33+
- Boot the ISO in QEMU/virt-manager
34+
- Smoke test:
35+
- Boot to live environment
36+
- Run `cvh-install` and complete an install on a disposable virtual disk
4637

47-
- Clearly explain what your PR does
48-
- Link the related issue if applicable
49-
- Do not mix unrelated changes in one PR
50-
- Follow the existing code style
51-
- Be open to feedback and review comments
38+
VM walkthrough: [docs/TESTING.md](docs/TESTING.md).
5239

53-
Low-quality or incomplete PRs may be closed.
40+
## Submitting a PR
5441

55-
---
56-
57-
## Code Quality Expectations
58-
59-
- Code should be readable and maintainable
60-
- Avoid unnecessary complexity
61-
- Follow project-specific style and structure
62-
- Document non-obvious logic
63-
- Do not commit generated files unless required
64-
65-
---
66-
67-
## Issues and Discussions
68-
69-
- Use issues for bugs, features, and tasks
70-
- Use discussions for questions and ideas
71-
- Search before opening a new issue
72-
73-
---
74-
75-
## Behavior and Conduct
76-
77-
- Be respectful and professional
78-
- No harassment, spam, or toxic behavior
79-
- Follow the Code of Conduct
80-
81-
Violations may result in removal from the project.
82-
83-
---
84-
85-
## Contributor Recognition
86-
87-
Meaningful contributions will be:
88-
- Reviewed and merged when appropriate
89-
- Credited in the project
90-
- Eligible for the @Contributors role on the CodeVerse Hub Discord server
91-
92-
---
93-
94-
## Questions
95-
96-
If you are unsure about anything:
97-
- Ask in GitHub Discussions
98-
- Ask in the CodeVerse Hub Discord server
99-
100-
We value collaboration and learning.
42+
1. Fork the repo and create a feature branch.
43+
2. Keep PRs focused (one logical change).
44+
3. Describe what changed and how it was tested.
45+
4. Submit a pull request using the PR template.

0 commit comments

Comments
 (0)