docs: streamline repo docs, point to ra-h.app/docs
- Delete CODE_OF_CONDUCT.md (generic boilerplate) - Simplify README.md, link to ra-h.app/docs as primary - Simplify CONTRIBUTING.md - Fix bug_report.md (was referencing PostgreSQL, uses SQLite) - Gut bloated PR template - Simplify feature_request.md - Update docs/README.md to point to website - Update docs/9_open-source.md
This commit is contained in:
“BeeRad”
@@ -1,53 +1,29 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
about: Report a bug
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Bug Description
|
||||
A clear and concise description of what the bug is.
|
||||
## What happened?
|
||||
|
||||
## Steps to Reproduce
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
## Steps to reproduce
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Expected Behavior
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
A clear and concise description of what actually happened.
|
||||
|
||||
## Screenshots
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
## Expected behavior
|
||||
|
||||
## Environment
|
||||
- OS: [e.g., macOS 13.5, Ubuntu 22.04, Windows 11]
|
||||
- Node.js Version: [e.g., 18.17.0]
|
||||
- Browser: [e.g., Chrome 115, Firefox 116, Safari 16.6]
|
||||
- RA-H Version: [e.g., 0.1.0]
|
||||
- OS: [e.g., macOS 14.0]
|
||||
- Node.js: [e.g., 18.17.0]
|
||||
- Browser: [e.g., Chrome 120]
|
||||
|
||||
## Database Information
|
||||
- PostgreSQL Version: [if known]
|
||||
- Docker Version: [if using Docker]
|
||||
- Any error messages from database logs
|
||||
## Error messages
|
||||
```
|
||||
Paste any error messages here
|
||||
```
|
||||
|
||||
## Additional Context
|
||||
- Error messages (include full stack traces if available)
|
||||
- Console output
|
||||
- Network tab information (if API-related)
|
||||
- Any other context about the problem
|
||||
|
||||
## Possible Solution
|
||||
If you have ideas on how to fix the issue, please describe them here.
|
||||
|
||||
## Checklist
|
||||
- [ ] I have searched existing issues to ensure this is not a duplicate
|
||||
- [ ] I have provided all the requested information
|
||||
- [ ] I can reproduce this issue consistently
|
||||
- [ ] I have included error messages and logs where applicable
|
||||
## Screenshots
|
||||
If applicable.
|
||||
|
||||
@@ -1,52 +1,16 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
about: Suggest an idea
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
## Problem
|
||||
What are you trying to solve?
|
||||
|
||||
## Proposed Solution
|
||||
A clear and concise description of what you want to happen.
|
||||
## Proposed solution
|
||||
What would you like to see?
|
||||
|
||||
## Alternative Solutions
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
## Use Cases
|
||||
Describe specific use cases where this feature would be helpful:
|
||||
1. Use case 1: [description]
|
||||
2. Use case 2: [description]
|
||||
|
||||
## Implementation Ideas
|
||||
If you have ideas on how this could be implemented, please describe them:
|
||||
- Frontend changes needed
|
||||
- Backend/API changes needed
|
||||
- Database schema changes
|
||||
- New dependencies required
|
||||
|
||||
## Priority
|
||||
How important is this feature to you?
|
||||
- [ ] Nice to have
|
||||
- [ ] Important for my workflow
|
||||
- [ ] Critical for adoption
|
||||
|
||||
## Mockups/Examples
|
||||
If applicable, add mockups, wireframes, or examples to help explain your request.
|
||||
|
||||
## Additional Context
|
||||
Add any other context, links to similar features in other apps, or screenshots about the feature request here.
|
||||
|
||||
## Acceptance Criteria
|
||||
What would need to be true for this feature to be considered complete?
|
||||
- [ ] Criteria 1
|
||||
- [ ] Criteria 2
|
||||
- [ ] Criteria 3
|
||||
|
||||
## Related Issues
|
||||
Are there any existing issues that relate to this request?
|
||||
- Fixes #
|
||||
- Related to #
|
||||
## Alternatives considered
|
||||
Any other approaches you've thought about?
|
||||
|
||||
@@ -1,125 +1,19 @@
|
||||
# Pull Request
|
||||
|
||||
## Description
|
||||
Brief description of what this PR does and why.
|
||||
## What does this PR do?
|
||||
|
||||
## Type of Change
|
||||
Please delete options that are not relevant.
|
||||
## Type
|
||||
- [ ] Bug fix
|
||||
- [ ] New feature
|
||||
- [ ] Documentation
|
||||
- [ ] Refactor
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] Documentation update
|
||||
- [ ] Code refactoring (no functional changes)
|
||||
- [ ] Performance improvement
|
||||
- [ ] Test coverage improvement
|
||||
## Related issue
|
||||
Closes #
|
||||
|
||||
## Related Issues
|
||||
Closes #[issue number]
|
||||
Related to #[issue number]
|
||||
|
||||
## Changes Made
|
||||
- [ ] Change 1: Description
|
||||
- [ ] Change 2: Description
|
||||
- [ ] Change 3: Description
|
||||
|
||||
## How Has This Been Tested?
|
||||
Please describe the tests that you ran to verify your changes:
|
||||
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests
|
||||
- [ ] Manual testing
|
||||
- [ ] API endpoint testing (if applicable)
|
||||
- [ ] Database operations verified
|
||||
- [ ] UI/UX testing (if applicable)
|
||||
|
||||
### Test Configuration
|
||||
- Node.js version: [e.g., 18.17.0]
|
||||
- Operating System: [e.g., macOS 13.5]
|
||||
- Database: [e.g., PostgreSQL 15 with pgvector]
|
||||
|
||||
## Screenshots/Videos
|
||||
If applicable, add screenshots or videos to demonstrate the changes.
|
||||
|
||||
### Before
|
||||
[Screenshot/description of before state]
|
||||
|
||||
### After
|
||||
[Screenshot/description of after state]
|
||||
|
||||
## Database Changes
|
||||
- [ ] No database changes
|
||||
- [ ] Schema changes (describe below)
|
||||
- [ ] Migration required
|
||||
- [ ] Seeds/fixtures updated
|
||||
|
||||
If database changes are made, describe them:
|
||||
```sql
|
||||
-- Example of schema changes
|
||||
```
|
||||
|
||||
## API Changes
|
||||
- [ ] No API changes
|
||||
- [ ] New endpoints added
|
||||
- [ ] Existing endpoints modified
|
||||
- [ ] Breaking changes to API
|
||||
|
||||
If API changes are made, describe them:
|
||||
```typescript
|
||||
// Example of API changes
|
||||
```
|
||||
|
||||
## Performance Impact
|
||||
- [ ] No performance impact expected
|
||||
- [ ] Performance improvement
|
||||
- [ ] Potential performance impact (explain below)
|
||||
|
||||
## Security Considerations
|
||||
- [ ] No security implications
|
||||
- [ ] Security improvement
|
||||
- [ ] Potential security impact (explain below)
|
||||
|
||||
## Documentation
|
||||
- [ ] Documentation updated
|
||||
- [ ] No documentation changes needed
|
||||
- [ ] Documentation to be updated in separate PR
|
||||
## Testing done
|
||||
|
||||
## Checklist
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings or errors
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published
|
||||
|
||||
## Deployment Notes
|
||||
Special instructions for deploying this change:
|
||||
- [ ] No special deployment requirements
|
||||
- [ ] Environment variables need to be updated
|
||||
- [ ] Database migration required
|
||||
- [ ] External service configuration needed
|
||||
|
||||
## Breaking Changes
|
||||
If this introduces breaking changes, describe the migration path:
|
||||
|
||||
## Additional Notes
|
||||
Any additional information that reviewers should know:
|
||||
|
||||
---
|
||||
|
||||
## For Reviewers
|
||||
### Review Focus Areas
|
||||
Please pay special attention to:
|
||||
- [ ] Code quality and style
|
||||
- [ ] Test coverage
|
||||
- [ ] Performance implications
|
||||
- [ ] Security considerations
|
||||
- [ ] Documentation accuracy
|
||||
|
||||
### Testing Instructions
|
||||
Specific steps for reviewers to test this change:
|
||||
1. Step 1
|
||||
2. Step 2
|
||||
3. Step 3
|
||||
- [ ] `npm run build` passes
|
||||
- [ ] `npm run type-check` passes
|
||||
- [ ] `npm run lint` passes
|
||||
|
||||
Reference in New Issue
Block a user