Added new features to the project
This commit is contained in:
ajaysi
63
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
63
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
name: 🐛 Bug Report
|
||||
about: Create a report to help us improve ALwrity
|
||||
title: '[BUG] '
|
||||
labels: ['bug', 'needs-triage']
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🐛 Bug Description
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## 🔄 Steps to Reproduce
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
## ✅ 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.
|
||||
|
||||
## 🖥️ Environment Information
|
||||
**Desktop/Server:**
|
||||
- OS: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
|
||||
- Python Version: [e.g. 3.10.5]
|
||||
- ALwrity Version: [e.g. latest, commit hash]
|
||||
- Browser: [e.g. Chrome 96, Firefox 95] (if applicable)
|
||||
|
||||
**Mobile (if applicable):**
|
||||
- Device: [e.g. iPhone 13, Samsung Galaxy S21]
|
||||
- OS: [e.g. iOS 15.1, Android 12]
|
||||
- Browser: [e.g. Safari, Chrome Mobile]
|
||||
|
||||
## 🔧 Configuration
|
||||
- AI Provider: [e.g. OpenAI, Google Gemini, Anthropic]
|
||||
- Features Used: [e.g. Blog Writer, SEO Tools, Social Media]
|
||||
- API Keys Configured: [List which APIs you have configured - don't share actual keys]
|
||||
|
||||
## 📋 Error Logs
|
||||
If applicable, paste any error messages or logs here:
|
||||
|
||||
```
|
||||
Paste error logs here
|
||||
```
|
||||
|
||||
## 🔍 Additional Context
|
||||
Add any other context about the problem here. This could include:
|
||||
- When did this start happening?
|
||||
- Does it happen consistently or intermittently?
|
||||
- Have you tried any workarounds?
|
||||
- Any recent changes to your setup?
|
||||
|
||||
## ✅ Checklist
|
||||
- [ ] I have searched for existing issues that describe this bug
|
||||
- [ ] I have included all relevant information above
|
||||
- [ ] I have tested this with the latest version of ALwrity
|
||||
- [ ] I have checked the [documentation](https://github.com/AJaySi/AI-Writer/wiki) for solutions
|
||||
74
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
74
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
name: 💡 Feature Request
|
||||
about: Suggest an idea for ALwrity
|
||||
title: '[FEATURE] '
|
||||
labels: ['enhancement', 'needs-discussion']
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🚀 Feature Summary
|
||||
A clear and concise description of the feature you'd like to see added to ALwrity.
|
||||
|
||||
## 🎯 Problem Statement
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
## 💡 Proposed Solution
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
## 🔄 Alternative Solutions
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
## 🎨 Mockups/Examples
|
||||
If applicable, add mockups, screenshots, or examples to help explain your feature request.
|
||||
|
||||
## 📊 Use Cases
|
||||
Describe specific use cases where this feature would be valuable:
|
||||
1. **Use Case 1**: [Description]
|
||||
2. **Use Case 2**: [Description]
|
||||
3. **Use Case 3**: [Description]
|
||||
|
||||
## 🎯 Target Users
|
||||
Who would benefit from this feature?
|
||||
- [ ] Content Creators/Bloggers
|
||||
- [ ] Digital Marketers
|
||||
- [ ] Social Media Managers
|
||||
- [ ] SEO Specialists
|
||||
- [ ] Business Owners
|
||||
- [ ] Developers
|
||||
- [ ] Other: [Please specify]
|
||||
|
||||
## 📈 Impact Assessment
|
||||
**How would this feature improve ALwrity?**
|
||||
- [ ] Improves user experience
|
||||
- [ ] Adds new functionality
|
||||
- [ ] Enhances existing features
|
||||
- [ ] Improves performance
|
||||
- [ ] Increases accessibility
|
||||
- [ ] Supports new platforms/integrations
|
||||
- [ ] Other: [Please specify]
|
||||
|
||||
## 🔧 Technical Considerations
|
||||
**Do you have any technical insights or requirements?**
|
||||
- Preferred AI models or APIs
|
||||
- Integration requirements
|
||||
- Performance considerations
|
||||
- Compatibility needs
|
||||
|
||||
## 📚 Additional Context
|
||||
Add any other context, research, or examples about the feature request here.
|
||||
|
||||
## 🌟 Priority Level
|
||||
How important is this feature to you?
|
||||
- [ ] Nice to have
|
||||
- [ ] Would be helpful
|
||||
- [ ] Important for my workflow
|
||||
- [ ] Critical/Blocking my use case
|
||||
|
||||
## ✅ Checklist
|
||||
- [ ] I have searched for existing feature requests
|
||||
- [ ] I have checked the [roadmap](https://github.com/AJaySi/AI-Writer/blob/main/Roadmap%20TBDs/ROADMAP.md) to see if this is already planned
|
||||
- [ ] I have provided clear use cases and examples
|
||||
- [ ] I understand this is a request and not a guarantee of implementation
|
||||
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
# 🚀 Pull Request
|
||||
|
||||
## 📋 Description
|
||||
Brief description of what this PR does and why it's needed.
|
||||
|
||||
## 🔗 Related Issues
|
||||
Fixes #(issue number)
|
||||
Closes #(issue number)
|
||||
Related to #(issue number)
|
||||
|
||||
## 🎯 Type of Change
|
||||
- [ ] 🐛 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
|
||||
- [ ] 🎨 Style/UI changes
|
||||
- [ ] ♻️ Code refactoring
|
||||
- [ ] ⚡ Performance improvements
|
||||
- [ ] 🧪 Test additions or updates
|
||||
- [ ] 🔧 Build/CI changes
|
||||
|
||||
## 🧪 Testing
|
||||
**How has this been tested?**
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests
|
||||
- [ ] Manual testing
|
||||
- [ ] Tested with different AI providers
|
||||
- [ ] Tested on different platforms
|
||||
|
||||
**Test Configuration:**
|
||||
- Python version:
|
||||
- OS:
|
||||
- AI Provider(s) tested:
|
||||
|
||||
## 📸 Screenshots (if applicable)
|
||||
Add screenshots to help explain your changes.
|
||||
|
||||
## ✅ Checklist
|
||||
- [ ] My code follows the project's style guidelines
|
||||
- [ ] I have performed a self-review of my own 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
|
||||
- [ ] 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
|
||||
|
||||
## 📝 Additional Notes
|
||||
Any additional information, concerns, or notes for reviewers.
|
||||
|
||||
## 🔄 Breaking Changes
|
||||
If this is a breaking change, please describe the impact and migration path for existing users.
|
||||
|
||||
## 📚 Documentation
|
||||
- [ ] README updated
|
||||
- [ ] Wiki/docs updated
|
||||
- [ ] API documentation updated
|
||||
- [ ] Comments added to code
|
||||
|
||||
---
|
||||
|
||||
**Thank you for contributing to ALwrity! 🎉**
|
||||
Reference in New Issue
Block a user