aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAhmed <git@gumx.cc>2026-06-20 00:08:09 +0300
committerAhmed <git@gumx.cc>2026-06-20 00:08:09 +0300
commitfb16e4b6c9c597c01c1eb1649603b8a761d0cc31 (patch)
tree61a1c89eec0393bc1217679f2b60fcf34c5b018b /CONTRIBUTING.md
parent9a2ac6cfad9855344f9bcc0b45780b4bcb1ff42d (diff)
fix: bunch of vibed edits to fix vibed edits
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7173170..5084164 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ title: contributing guide
# contributing to ubergeek
-ubergeek is a community study guide. Contributions are welcome — fixes,
+ubergeek is a community study guide. Contributions are welcome: fixes,
improvements, new exercises, better explanations, and sample projects.
The primary repository lives on **sourcehut** and is mirrored to GitHub and
@@ -14,13 +14,13 @@ GitLab. You can contribute from any platform.
## Ways to Contribute
-- **Fix errors** — typos, incorrect information, broken examples
-- **Improve explanations** — clearer wording, better analogies, added context
-- **Add exercises and projects** — practice problems, mini-projects, challenge sets
-- **Add sample code** — working examples in any of the covered languages
-- **Add diagrams and images** — ASCII art, schematics, architecture diagrams
-- **Review existing content** — flag sections that are confusing or incomplete
-- **Suggest new topics or modules** — open a discussion first
+- **Fix errors**: typos, incorrect information, broken examples
+- **Improve explanations**: clearer wording, better analogies, added context
+- **Add exercises and projects**: practice problems, mini-projects, challenge sets
+- **Add sample code**: working examples in any of the covered languages
+- **Add diagrams and images**: ASCII art, schematics, architecture diagrams
+- **Review existing content**: flag sections that are confusing or incomplete
+- **Suggest new topics or modules**: open a discussion first
---
@@ -50,14 +50,14 @@ topic-name/
## Content Style Guide
### Tone
-- Direct and practical — teach by showing, not lecturing
+- Direct and practical: teach by showing, not lecturing
- Assume intelligence, not prior knowledge
- Use "you" not "the student" or "one"
### Structure
- Every page starts with frontmatter (`title` required)
- Open with a short paragraph explaining what and why
-- Use code blocks liberally — real, runnable examples
+- Use code blocks liberally: real, runnable examples
- End modules with exercises (drill, challenges, mini-project)
- End with key takeaways and a "Next" link
@@ -154,7 +154,7 @@ git push origin fix-typo-shell-basics
```
### PR/MR Guidelines
-- Keep PRs focused — one fix or one module per PR
+- Keep PRs focused: one fix or one module per PR
- Write a clear description of what you changed and why
- If adding a new module, open an issue first to discuss scope
@@ -164,12 +164,12 @@ git push origin fix-typo-shell-basics
When adding to `samples/`:
-- **Must compile/run out of the box** — include a Makefile, requirements.txt,
+- **Must compile/run out of the box**: include a Makefile, requirements.txt,
Cargo.toml, or whatever the project needs
-- **Include a README.md** — what it does, how to build, how to run, expected output
-- **Keep it minimal** — demonstrate the concept, nothing more
-- **Pin dependencies** where practical — don't rely on "latest"
-- **Test on Linux** — that's the primary platform for this guide
+- **Include a README.md**: what it does, how to build, how to run, expected output
+- **Keep it minimal**: demonstrate the concept, nothing more
+- **Pin dependencies** where practical: don't rely on "latest"
+- **Test on Linux**: that's the primary platform for this guide
### KiCad / Hardware Projects
@@ -189,13 +189,13 @@ When adding to `samples/`:
```
Types:
-- `content` — new or updated study material
-- `fix` — corrections to existing content
-- `exercises` — new or updated exercises
-- `samples` — new or updated sample code/projects
-- `images` — new or updated diagrams/images
-- `meta` — PROGRESS.md, CONTRIBUTING.md, index.md, study-plan.md
-- `infra` — CI, build scripts, tooling
+- `content`: new or updated study material
+- `fix`: corrections to existing content
+- `exercises`: new or updated exercises
+- `samples`: new or updated sample code/projects
+- `images`: new or updated diagrams/images
+- `meta`: PROGRESS.md, CONTRIBUTING.md, index.md, study-plan.md
+- `infra`: CI, build scripts, tooling
Examples:
```
@@ -211,7 +211,7 @@ samples: add bare-metal blinky project for STM32F4
1. All contributions are reviewed before merging
2. Content accuracy is the top priority
-3. Style and formatting can be fixed post-merge — don't let it block good content
+3. Style and formatting can be fixed post-merge; don't let it block good content
4. Disagreements are resolved by discussion, not authority
---