diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bd4f9d..bbd327f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -260,54 +260,24 @@ Fixes #189 feat(converter): add Ruby language support ``` -2. **Description:** Use the PR template - ```markdown - ## Description - Brief description of what this PR does. - - ## Related Issues - Closes #123 - - ## Type of Change - - [ ] Bug fix - - [ ] New feature - - [ ] Breaking change - - [ ] Documentation update - - ## Testing - Steps to test this change: - 1. Start Docker: `docker-compose up -d` - 2. Navigate to http://localhost - 3. Select Ruby as source language - 4. Paste some Ruby code - 5. Select target language and click "Run AI" - - ## Screenshots (if applicable) - [Before] / [After] - - ## Checklist - - [ ] Code passes linting (`npm run biome:lint`) - - [ ] Changes are tested - - [ ] Documentation is updated - - [ ] No console errors in dev tools - - [ ] Commits follow guidelines - ``` +2. **Description:** Explain what and why + - What does this PR do? + - Why is this change needed? + - Any testing done? -3. **Link issues:** Reference related issues -4. **No draft PRs:** Only open when ready for review -5. **Keep it focused:** One feature or fix per PR +3. **Link issues:** Reference related issues if any +4. **Keep it focused:** One feature or fix per PR ### During Review - Be open to feedback - Respond to questions promptly -- Make requested changes in new commits (don't force push) -- Use the GitHub "Re-request review" button after updates -- Keep conversation professional and constructive +- Make requested changes in new commits +- Keep conversation professional ### After Approval -- Ensure CI/CD passes +- Ensure no conflicts - A maintainer will merge your PR - Your contribution will be recognized! diff --git a/README.md b/README.md index a4ee708..21c6327 100644 --- a/README.md +++ b/README.md @@ -332,19 +332,21 @@ This is an experimental project with real limitations: - **Error handling:** Limited error checking and validation - **Production use:** Not suitable for mission-critical workflows without thorough testing -## 🚨 Reporting Issues & Security +## � Support & Feedback -### Bug Reports -- **Use the bug report template** provided in GitHub Issues -- **Include reproduction steps** and expected vs. actual behavior -- **Environment info:** OS, Docker version, any custom configs -- **No duplicate reports:** Search existing issues first +- **Report bugs:** Open a GitHub Issue with details and reproduction steps +- **Ask questions:** Use GitHub Discussions for questions and ideas +- **Contribute:** See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines +- **Code of Conduct:** See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) -### Security Vulnerabilities -- **Don't open public issues** for security vulnerabilities -- **Email us privately:** [security@example.com] -- **Include:** Version, reproduction steps, and potential impact -- **Responsible disclosure:** Allow 48 hours before public disclosure +## 🚨 Security + +Found a security vulnerability? Please email [security@example.com] with: +- Description of the issue +- Steps to reproduce +- Potential impact + +Please allow 48 hours before public disclosure. See `frontend/README.md` for detailed customization guides. @@ -376,9 +378,9 @@ Distributed under the **MIT License**. See [LICENSE](./LICENSE) for details. ## 💬 Support -- **Issues:** Report bugs on [GitHub Issues](https://github.com/codepapi/codepapi-ai/issues) -- **Discussions:** Ask questions in [GitHub Discussions](https://github.com/codepapi/codepapi-ai/discussions) -- **Docs:** Full documentation in [README files](./frontend/README.md) +- **Report bugs:** GitHub Issues +- **Ask questions:** GitHub Discussions +- **Documentation:** [CONTRIBUTING.md](./CONTRIBUTING.md), [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) --- @@ -386,6 +388,6 @@ Distributed under the **MIT License**. See [LICENSE](./LICENSE) for details. **A learning project exploring local LLMs in development workflows** -[⭐ Star us on GitHub](https://github.com/codepapi/codepapi-ai) • [🐛 Report a Bug](https://github.com/codepapi/codepapi-ai/issues) • [💡 Suggest a Feature](https://github.com/codepapi/codepapi-ai/discussions) +[⭐ GitHub](https://github.com/codepapi/codepapi-ai) • [🐛 Issues](https://github.com/codepapi/codepapi-ai/issues) • [💬 Discussions](https://github.com/codepapi/codepapi-ai/discussions)