docs: add contributing guidelines and github templates by kavix · Pull Request #20 · clencyc/LiveEdit

kavix · 2026-06-09T19:42:01Z

Add Contributing Guidelines and GitHub Templates

#13
Fixes #42

Summary

This PR introduces comprehensive contributor documentation and standardized GitHub templates to streamline onboarding, improve contribution quality, and establish consistent development workflows across the project.

Changes Made

1. Added `CONTRIBUTING.md`

Created a detailed contribution guide covering:

Development Environment Setup
- Flask backend setup and configuration
- React frontend installation and setup
- Environment variable configuration
- Database initialization steps
Testing Guidelines
- Manual API testing procedures
- Frontend verification in the browser
Code Style Standards
- Python style guidelines (PEP 8)
- TypeScript/React best practices
- Functional component usage
- Strict typing requirements
Git Workflow
- Conventional Commit conventions (feat, fix, docs, etc.)
- Branching strategy
- Commit message standards
Pull Request Process
- End-to-end contribution workflow
- Code review expectations
- Submission guidelines
Issue Reporting
- Best practices for reporting bugs
- Required information for actionable reports

2. Added GitHub Templates

Introduced standardized templates to improve issue and PR quality:

.github/ISSUE_TEMPLATE/bug_report.md
- Structured bug reporting form
- Reproduction steps
- Environment details
- Expected vs. actual behavior
.github/ISSUE_TEMPLATE/feature_request.md
- Consistent format for proposing enhancements
- Use case and benefit documentation
.github/pull_request_template.md
- Contributor checklist
- Testing verification
- Review readiness requirements

3. Updated `README.md`

Added a direct link to the new CONTRIBUTING.md guide in the Contributing section.

Motivation

These additions lower the barrier to entry for new contributors, provide clear development standards, and help maintain code quality through a consistent contribution process. Standardized templates also reduce review friction by ensuring that issues and pull requests contain the necessary information from the start.

Checklist

Added CONTRIBUTING.md with setup, style, and contribution guidelines
Added bug report issue template
Added feature request issue template
Added pull request template
Updated README.md to link to the contribution guide

Summary by CodeRabbit

Documentation
- Added standardized bug report and feature request templates for GitHub issues
- Added pull request template for consistent PR submissions
- Updated contributing guide with clearer setup instructions for backend/frontend development and testing procedures
- Simplified README contribution section with reference to dedicated contributing guide

vercel · 2026-06-09T19:42:05Z

@kavix is attempting to deploy a commit to the ClaraClency Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2026-06-09T19:42:16Z

Warning

Review limit reached

@kavix, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 26 minutes and 36 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 226ad3d7-f737-4624-b6f9-3119880d9e40

📥 Commits

Reviewing files that changed from the base of the PR and between 4ad36b1 and 82bb058.

📒 Files selected for processing (1)

.github/ISSUE_TEMPLATE/bug_report.md

📝 Walkthrough

Walkthrough

This PR adds standardized contribution templates and rewrites the contribution guide. Three new GitHub issue/PR templates define structured forms for bug reports, feature requests, and pull requests. The CONTRIBUTING.md guide is rewritten with explicit prerequisites, local development setup steps for backend and frontend, testing guidance, code style and commit conventions, and PR workflow. README.md is simplified to reference the new CONTRIBUTING.md.

Changes

Contribution Process Standardization

Layer / File(s)	Summary
GitHub issue and pull request templates `.github/ISSUE_TEMPLATE/bug_report.md`, `.github/ISSUE_TEMPLATE/feature_request.md`, `.github/pull_request_template.md`	Added YAML-structured templates for bug reports, feature requests, and PRs with required sections for issue details, reproduction steps, testing instructions, and completion checklists.
Development environment setup guide `CONTRIBUTING.md` (lines 3–57)	Specified prerequisites (Node.js 18+, Python 3.10+, FFmpeg, Redis, PostgreSQL) and step-by-step local environment setup for backend and frontend, including virtualenv activation, environment file configuration, and database initialization.
Contribution workflows and code conventions `CONTRIBUTING.md` (lines 59–96)	Defined code style requirements, Conventional Commits format with examples, PR process steps, and updated guidance for bug reporting and feature requests.
Documentation updates and closing message `CONTRIBUTING.md` (lines 110–112), `README.md` (line 315)	Added closing thanks message to CONTRIBUTING.md and simplified README's Contributing section to reference the full CONTRIBUTING.md guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related issues

clencyc/LiveEdit#13: This PR directly implements the requested CONTRIBUTING.md and GitHub templates (bug_report, feature_request, pull_request) for standardizing contributor workflows.

Possibly related PRs

clencyc/LiveEdit#18: Also updates CONTRIBUTING.md with contributor and development setup content.

Poem

🐰 A rabbit hops through templates neat,
Bug forms and feature requests so sweet,
Contributing guide, a developer's treat,
Setup steps and workflows complete,
Now contributions flow so neat! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main changes: adding contribution guidelines and GitHub templates for issues and pull requests.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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 and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 26-29: Replace the incorrect "iOS" example in the "Desktop (please
complete the following information):" section with appropriate desktop OS
examples; update the Browser/Version lines if desired to keep examples coherent
(suggested replacements: "macOS", "Windows 10", or "Ubuntu 22.04") so the
Desktop example reflects actual desktop operating systems.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e6038e2a-a8e3-4cb2-bd59-ba1c708e3c55

📥 Commits

Reviewing files that changed from the base of the PR and between 248adfe and 4ad36b1.

📒 Files selected for processing (5)

.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/pull_request_template.md
CONTRIBUTING.md
README.md

netlify · 2026-06-09T20:05:25Z

✅ Deploy Preview for livedit canceled.

Name	Link
🔨 Latest commit	`82bb058`
🔍 Latest deploy log	https://app.netlify.com/projects/livedit/deploys/6a2874637c8ddb00084780ae

kavix

Changed

docs: add contributing guidelines and github templates

4ad36b1

kavix mentioned this pull request Jun 9, 2026

Create contributing guide and issue templates #13

Open

14 tasks

coderabbitai Bot reviewed Jun 9, 2026

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/bug_report.md

Update bug_report.md

82bb058

kavix commented Jun 11, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add contributing guidelines and github templates#20

docs: add contributing guidelines and github templates#20
kavix wants to merge 2 commits into
clencyc:masterfrom
kavix:master

kavix commented Jun 9, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jun 9, 2026

Uh oh!

coderabbitai Bot commented Jun 9, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

netlify Bot commented Jun 9, 2026 •

edited

Loading

Uh oh!

kavix left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

kavix commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add Contributing Guidelines and GitHub Templates

Summary

Changes Made

1. Added CONTRIBUTING.md

2. Added GitHub Templates

3. Updated README.md

Motivation

Checklist

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jun 9, 2026

Uh oh!

coderabbitai Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for livedit canceled.

Uh oh!

kavix left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kavix commented Jun 9, 2026 •

edited

Loading

1. Added `CONTRIBUTING.md`

3. Updated `README.md`

coderabbitai Bot commented Jun 9, 2026 •

edited

Loading

netlify Bot commented Jun 9, 2026 •

edited

Loading