Skip to content

fix: updated read me #8

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
CodePapi merged 1 commit into from
Feb 8, 2026
Merged

fix: updated read me #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 9 additions & 39 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
32 changes: 17 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -376,16 +378,16 @@ 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)

---

<div align="center">

**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)

</div>