Skip to content

Commit edbd144

Browse files
committed
fix: updated read me
1 parent 12b6eb5 commit edbd144

File tree

2 files changed

+26
-54
lines changed

2 files changed

+26
-54
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -260,54 +260,24 @@ Fixes #189
260260
feat(converter): add Ruby language support
261261
```
262262

263-
2. **Description:** Use the PR template
264-
```markdown
265-
## Description
266-
Brief description of what this PR does.
267-
268-
## Related Issues
269-
Closes #123
270-
271-
## Type of Change
272-
- [ ] Bug fix
273-
- [ ] New feature
274-
- [ ] Breaking change
275-
- [ ] Documentation update
276-
277-
## Testing
278-
Steps to test this change:
279-
1. Start Docker: `docker-compose up -d`
280-
2. Navigate to http://localhost
281-
3. Select Ruby as source language
282-
4. Paste some Ruby code
283-
5. Select target language and click "Run AI"
284-
285-
## Screenshots (if applicable)
286-
[Before] / [After]
287-
288-
## Checklist
289-
- [ ] Code passes linting (`npm run biome:lint`)
290-
- [ ] Changes are tested
291-
- [ ] Documentation is updated
292-
- [ ] No console errors in dev tools
293-
- [ ] Commits follow guidelines
294-
```
263+
2. **Description:** Explain what and why
264+
- What does this PR do?
265+
- Why is this change needed?
266+
- Any testing done?
295267

296-
3. **Link issues:** Reference related issues
297-
4. **No draft PRs:** Only open when ready for review
298-
5. **Keep it focused:** One feature or fix per PR
268+
3. **Link issues:** Reference related issues if any
269+
4. **Keep it focused:** One feature or fix per PR
299270

300271
### During Review
301272

302273
- Be open to feedback
303274
- Respond to questions promptly
304-
- Make requested changes in new commits (don't force push)
305-
- Use the GitHub "Re-request review" button after updates
306-
- Keep conversation professional and constructive
275+
- Make requested changes in new commits
276+
- Keep conversation professional
307277

308278
### After Approval
309279

310-
- Ensure CI/CD passes
280+
- Ensure no conflicts
311281
- A maintainer will merge your PR
312282
- Your contribution will be recognized!
313283

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -332,19 +332,21 @@ This is an experimental project with real limitations:
332332
- **Error handling:** Limited error checking and validation
333333
- **Production use:** Not suitable for mission-critical workflows without thorough testing
334334

335-
## 🚨 Reporting Issues & Security
335+
## � Support & Feedback
336336

337-
### Bug Reports
338-
- **Use the bug report template** provided in GitHub Issues
339-
- **Include reproduction steps** and expected vs. actual behavior
340-
- **Environment info:** OS, Docker version, any custom configs
341-
- **No duplicate reports:** Search existing issues first
337+
- **Report bugs:** Open a GitHub Issue with details and reproduction steps
338+
- **Ask questions:** Use GitHub Discussions for questions and ideas
339+
- **Contribute:** See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines
340+
- **Code of Conduct:** See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
342341

343-
### Security Vulnerabilities
344-
- **Don't open public issues** for security vulnerabilities
345-
- **Email us privately:** [security@example.com]
346-
- **Include:** Version, reproduction steps, and potential impact
347-
- **Responsible disclosure:** Allow 48 hours before public disclosure
342+
## 🚨 Security
343+
344+
Found a security vulnerability? Please email [security@example.com] with:
345+
- Description of the issue
346+
- Steps to reproduce
347+
- Potential impact
348+
349+
Please allow 48 hours before public disclosure.
348350

349351
See `frontend/README.md` for detailed customization guides.
350352

@@ -376,16 +378,16 @@ Distributed under the **MIT License**. See [LICENSE](./LICENSE) for details.
376378

377379
## 💬 Support
378380

379-
- **Issues:** Report bugs on [GitHub Issues](https://github.com/codepapi/codepapi-ai/issues)
380-
- **Discussions:** Ask questions in [GitHub Discussions](https://github.com/codepapi/codepapi-ai/discussions)
381-
- **Docs:** Full documentation in [README files](./frontend/README.md)
381+
- **Report bugs:** GitHub Issues
382+
- **Ask questions:** GitHub Discussions
383+
- **Documentation:** [CONTRIBUTING.md](./CONTRIBUTING.md), [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
382384

383385
---
384386

385387
<div align="center">
386388

387389
**A learning project exploring local LLMs in development workflows**
388390

389-
[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)
391+
[⭐ GitHub](https://github.com/codepapi/codepapi-ai)[🐛 Issues](https://github.com/codepapi/codepapi-ai/issues)[💬 Discussions](https://github.com/codepapi/codepapi-ai/discussions)
390392

391393
</div>

0 commit comments

Comments
 (0)