Skip to content

Update CONTRIBUTING.md with review and issue guidelines #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zahnentferner merged 2 commits into from
Feb 25, 2026
Merged

Update CONTRIBUTING.md with review and issue guidelines #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d59ce0
Update CONTRIBUTING.md with review and issue guidelines
imxade Feb 24, 2026
c9a550d
Update CONTRIBUTING.md with clearer guidelines
imxade Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ git push origin feature/your-feature-name
- [ ] You've updated relevant documentation
- [ ] Your commits are clean and well-organized
- [ ] You've rebased with the latest upstream changes
- [ ] You've thought from the reviewer's perspective and made your PR easy to review

### Submitting a Pull Request

Expand Down Expand Up @@ -213,6 +214,12 @@ Steps to test the changes
- Respond to review comments promptly
- Make requested changes in new commits
- Be patient - maintainers will review when available
- Use `[WIP]` in your PR title for incomplete PRs. Don't use this as a way to gatekeep; focus on one change until it gets merged.

### Reviewing PRs

- Instead of opening duplicate PRs, help review and improve existing ones.
- When reviewing, assess whether the change is actually necessary before diving into implementation details and functionality testing.

## 📝 Code Style Guidelines

Expand All @@ -225,6 +232,7 @@ TODO: Add project-specific code style guidelines
- Add comments for complex logic
- Remove console.logs before committing
- Avoid code duplication
- Avoid unnecessary complexity and minor over-optimization

### JavaScript/TypeScript
- Use ES6+ syntax
Expand Down Expand Up @@ -521,9 +529,13 @@ If you encounter issues not covered here:
## 🎯 Issue Assignment

- One contributor per issue (unless specified otherwise)
<!--
- Wait for assignment before starting work
- Issues will be reassigned if inactive for extended periods
- Check for existing PRs before starting to avoid duplication
-->
- If there are no active PRs for an issue for 2+ days, mention your intent under the issue and begin
- Avoid working on issues which are assigned to someone, even if they are inactive
- Check for existing PRs before starting to avoid duplication, as there might PRs that didn't mention the related issue


Thank you for contributing to TODO! Your efforts help make this project better for everyone. 🚀
Loading