Repository navigation
hacktoberfest docs - #46
Merged
Merged
Conversation
🛡️ CodewardAll agents reported back clean. Completed in 178s. Full report on the dashboard → |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![codeward-code-review-agent[bot]](https://avatars.githubusercontent.com/in/4029840?s=60&v=4){kind=small}
There was a problem hiding this comment.
Codeward Guardian Review - PASS
Run #305 on repoId:80@9b364e114369afb9debee0c9bb6d049c0017750b.
📡 Track Live Sandbox Execution & Agent Feed on Codeward Dashboard →
Codeward analyzed this human-opened PR and Guardian is publishing the verified outcome.
Finding summary: No findings
Checks run
| Status | Check | Result |
|---|---|---|
| ✅ | PR diff review | Clean: adds Hacktoberfest contributor onboarding doc (WELCOME_ISSUE.md, 56 lines) |
Diff inspected: 1 file added (WELCOME_ISSUE.md). The change introduces a pinned welcome issue template for Hacktoberfest contributors with setup instructions, badge system, and ground rules. No code changes, no security concerns, no test requirements.
Changed code and evidence
These excerpts are generated from the current GitHub PR diff.
WELCOME_ISSUE.md (added, +56/-0)
@@ -0,0 +1,56 @@
+<!-- Create a new issue with this content, then pin it (… menu > Pin issue). -->
+
+**Title:** Welcome, Hacktoberfest contributors! Start here
+
+---
+
+Welcome to LiveEdit, an AI video editor built with Flask, Celery, React and Gemini. We're glad you're here.
+
+## Your first 15 minutes
+
+- [ ] Read [HOW_IT_WORKS.md](https://github.com/clencyc/LiveEdit/blob/master/HOW_IT_WORKS.md) (5 minutes: how the app fits together)
+- [ ] Pick an issue labelled [`good first issue`](https://github.com/clencyc/LiveEdit/issues?q=is%3Aopen+label%3A%22good+first+issue%22)
+- [ ] Comment "I'd like to work on this" and wait for a maintainer to assign you
+- [ ] Fork the repo and create a branch (`fix/short-description`)
+- [ ] Make your change and run the tests
+- [ ] Open a PR that says `Closes #<issue number>`
+
+## You don't need API keys
+
+Most contributions (tests, docs, UI polish, small fixes) need **no** Gemini, Google Cloud, Logto or Paystack account. The backend tests mock all of that. Please do **not** point a dev build at the production backend.
+
+```bash
+# Backend tests
+cd LiveEditBackend && python3 -m venv venv && source venv/bin/activate
+pip install -r requirements.txt pytest pytest-cov && pytest -v
+
+# Frontend tests
+cd LiveEditFronten && npm install && npm test
+```
+
+(The frontend folder really is spelled `LiveEditFronten`.)
+
+## Earn badges
+
+Every merged PR earns a badge, posted automatically in a comment on your PR:
+
+| Badge | For |
+| --- | --- |
+| First PR Merged | Your first merged PR |
+| Test Hero | Tests |
+| Bug Squasher | Bug fixes |
+| Docs Champion | Documentation |
+| Pixel Perfect | UI, design, accessibility |
+| Audio Alchemist | Audio effects |
+
+See [CONTRIBUTORS.md](https://github.com/clencyc/LiveEdit/blob/master/CONTRIBUTORS.md) for the Hall of Fame, and your name goes in the README contributors table too.
+
+## Ground rules
+
+- One issue at a time, one PR per issue. Keep PRs small.
+- Ask questions in the issue thread. There are no silly ones, and if an issue points at a file that doesn't exist, that's our mistake: tell us.
+- No low-effort or bulk "typo" PRs and no unreviewed AI-generated changes. They don't count and they slow everyone down.
+- Be kind and assume good intent.
+- Found a security problem? **Don't open a public issue.** Report it privately via the [Security tab](https://github.com/clencyc/LiveEdit/security/advisories/new).
+
+Happy hacking!
✅ Deploy Preview for livedit canceled.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Closes #
How did you test it?
Checklist
pytestinLiveEditBackend,npm testinLiveEditFronten).envfiles or large binariesScreenshots (for UI changes)