|
1 | | -# Contributing to CodeVerse Hub Projects |
| 1 | +# Contributing |
2 | 2 |
|
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). |
5 | 4 |
|
6 | | -This document explains how to get started and what is expected from contributors. |
| 5 | +## Setup (build environment) |
7 | 6 |
|
8 | | ---- |
| 7 | +This project builds an ArchISO and is easiest to work on from an **Arch-based host**. |
9 | 8 |
|
10 | | -## Who Can Contribute |
| 9 | +Required tools for ISO builds: |
11 | 10 |
|
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`) |
15 | 15 |
|
16 | | -You do not need prior open-source experience. |
| 16 | +Install (Arch): |
17 | 17 |
|
18 | | ---- |
| 18 | +- `sudo pacman -S archiso squashfs-tools libisoburn grub` |
19 | 19 |
|
20 | | -## How to Start |
| 20 | +If you touch `src/` (Rust tools), install Rust via rustup. |
21 | 21 |
|
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 |
31 | 23 |
|
32 | | ---- |
| 24 | +- Build packages: `./scripts/build-packages.sh` |
| 25 | +- Build ISO: `./scripts/build-iso.sh` |
33 | 26 |
|
34 | | -## Development Workflow |
| 27 | +More detail: [docs/BUILD.md](docs/BUILD.md). |
35 | 28 |
|
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 |
42 | 30 |
|
43 | | ---- |
| 31 | +Recommended: test in a VM first. |
44 | 32 |
|
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 |
46 | 37 |
|
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). |
52 | 39 |
|
53 | | -Low-quality or incomplete PRs may be closed. |
| 40 | +## Submitting a PR |
54 | 41 |
|
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