Skip to content

hacktoberfest docs - #45

Merged
clencyc merged 1 commit into
masterfrom
feature/test-badge
Oct 23, 2026
Merged

clencyc merged 1 commit into
masterfrom
feature/test-badge

Conversation

@clencyc

@clencyc clencyc commented Oct 23, 2026

Copy link
Copy Markdown
Owner

What does this PR do?

Closes #

How did you test it?

Checklist

  • This PR does one thing (one issue, one PR)
  • I ran the relevant tests locally (pytest in LiveEditBackend, npm test in LiveEditFronten)
  • I added or updated tests where it makes sense
  • I did not commit secrets, .env files or large binaries

Screenshots (for UI changes)

@codeward-code-review-agent

codeward-code-review-agent Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

🛡️ Codeward

Review complete — here's what the agents found:

Severity Count
🟠 High 1

Completed in 178s. Full report on the dashboard →

@coderabbitai

coderabbitai Bot commented Oct 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 52 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 333c011f-59c6-4b6e-81ef-899aba221ab6
📥 Commits

Reviewing files that changed from the base of the PR and between 041f9bc and 38eaaea.

📒 Files selected for processing: 1
  • HACKTOBERFEST_SETUP.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@clencyc
clencyc merged commit b879c6c into master Oct 23, 2026
5 of 9 checks passed

@codeward-code-review-agent codeward-code-review-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codeward Guardian Review - APPROVE

Run #304 on repoId:80@38eaaea.

📡 Track Live Sandbox Execution & Agent Feed on Codeward Dashboard →

Codeward analyzed this human-opened PR and Guardian is publishing the verified outcome.

Finding summary: The agent flagged a HIGH severity path traversal vulnerability in LiveEditBackend/app.py:695, but this finding is not relevant to the current PR. This PR adds only documentation (HACKTOBERFEST_SETUP.md) and introduces no code changes to app.py or any backend logic.

Checks run

Status Check Result
✅ PR diff review Documentation-only change; no code modified

Findings

The path traversal finding in app.py:695 exists in the base branch and is outside the scope of this PR. This PR adds Hacktoberfest setup documentation and contributor badge infrastructure—no security-relevant code changes.

Recommendation: The path traversal issue should be tracked separately. This PR is safe to merge.

Changed code and evidence

These excerpts are generated from the current GitHub PR diff.

HACKTOBERFEST_SETUP.md (added, +110/-0)
@@ -0,0 +1,110 @@
+# Hackathon kit: setup guide (about 20 minutes)
+
+You can delete this file after setup. Do the steps in order.
+
+## What's in the kit
+
+| File | Purpose |
+| --- | --- |
+| `.github/badges/*.svg` | 7 contributor badges |
+| `.github/scripts/generate_badges.py` | Regenerates the badges (change names, colours, icons) |
+| `.github/workflows/contributor-badges.yml` | Posts badges in a comment when a PR is merged |
+| `.github/scripts/create-labels.sh` | Creates the labels the workflow uses |
+| `.github/PULL_REQUEST_TEMPLATE.md` | PR checklist for contributors |
+| `.github/ISSUE_TEMPLATE/` | Template for writing good first issues, and a private security link |
+| `.all-contributorsrc` | Config for the All Contributors bot |
+| `CONTRIBUTORS.md` | Badge guide and Hall of Fame |
+| `WELCOME_ISSUE.md` | Text for a pinned "Start here" issue |
+
+## 1. Add the files to `master`
+
+Copy everything into the repo root and commit **directly to `master`**. The workflow only runs if it exists on the default branch.
+
+```bash
+git add .github CONTRIBUTORS.md .all-contributorsrc
+git commit -m "Add Hacktoberfest contributor badges and templates"
+git push origin master
+```
+
+Also commit `HOW_IT_WORKS.md` and the new `README.md` if you haven't yet.
+
+## 2. Make CI run on your PRs (important)
+
+`.github/workflows/tests.yml` currently triggers only for `main` and `develop`, but your default branch is `master`, so contributors get no test results. Change both triggers:
+
+```yaml
+on:
+  push:
+    branches: [master, main, develop]
+  pull_request:
+    branches: [master, main, develop]
+```
+
+## 3. Create the labels
+
+```bash
+gh auth login
+bash .github/scripts/create-labels.sh clencyc/LiveEdit
+```
+
+(Or create `badge:test`, `badge:bug`, `badge:docs`, `badge:design`, `badge:audio` by hand under Issues > Labels. The names must match exactly.)
+
+## 4. Repository settings
+
+- Add the topic **`hacktoberfest`** (repo main page > gear next to About > Topics).
+- Settings > Actions > General: make sure Actions are enabled.
+- Keep "Require approval for first-time contributors" on, so CI from strangers needs your OK.
+- Check hacktoberfest.com for this year's current rules.
+
+## 5. All Contributors (README wall of fame)
+
+1. Install the app: https://github.com/apps/allcontributors and give it access to the `LiveEdit` repo.
+2. Add this block to `README.md` where you want the table:
+
+```markdown
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+```
+
+3. To add someone, comment on any issue or PR:
+
+```
+@all-contributors please add @username for code, test, doc
+```
+
+Useful types: `code`, `test`, `doc`, `design`, `bug`, `ideas`, `audio`, `review`, `question`.
+
+## 6. Test the badge bot before the event
+
+The workflow skips PRs by the repo owner. To test with your own account:
+
+1. In `contributor-badges.yml`, temporarily delete the `if (pr.author_association === 'OWNER') { ... }` block and push to `master`.
+2. Open a throwaway PR (for example a one-line change to `CONTRIBUTORS.md`), add the label `badge:docs`, and merge it.
+3. Check the PR for the badge comment.
+4. Restore the block and revert the throwaway change.
+
+If nothing appears, open the Actions tab and read the "Contributor badges" run.
+
+## 7. Pin the welcome issue
+
+Create a new issue from `WELCOME_ISSUE.md`, then use the `...` menu > Pin issue.
+
+## Your routine while the event runs
+
+1. Review the PR. Ask for changes if needed.
+2. Add **one** badge label (`badge:test`, `badge:bug`, `badge:docs`, `badge:design` or `badge:audio`). Everyone also gets First PR and Hacktoberfest badges automatically.
+3. Merge. The bot posts the badges.
+4. Add a row to the Hall of Fame in `CONTRIBUTORS.md`.
+5. Comment `@all-contributors please add @username for ...`.
+
+## Notes
+
+- **Security:** the workflow uses `pull_request_target`. It is safe because it never checks out or runs PR code. Never add a step that does.
+- **Spam:** badges are awarded on merge only, so low-effort PRs earn nothing.
+- **Changing badges:** edit `BADGES` in `generate_badges.py`, run `python .github/scripts/generate_badges.py`, commit the SVGs. For a new badge also add a label entry in the workflow's `LABEL_BADGES`.

This branch was successfully deployed

1 active deployment
Preview — 38eaaead Deployed Oct 23, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant