docs: add GitHub issue templates and update project documentation

pimoussTO · pimoussTO · commit e45f91fdf422 · 2024-11-28T16:00:47.000-05:00
This commit adds new GitHub issue templates for bug reports and feature
requests, updates the pull request template, and enhances various
project documentation files to improve the contribution process and
provide better guidance for users and contributors.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,30 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+**Describe the Bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run command '...'
+2. Enter input '....'
+3. See error
+
+**Expected Behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment:**
+ - OS: [e.g. Ubuntu 20.04]
+ - Python Version: [e.g. 3.9]
+ - Wellcode CLI Version: [e.g. 1.0.0]
+
+**Additional Context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+**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 [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,27 @@
+## Description
+<!-- Describe your changes in detail -->
+
+## Related Issue
+<!-- Please link to the issue here -->
+Fixes #
+
+## Type of Change
+<!-- Please delete options that are not relevant -->
+- [ ] Bug fix (non-breaking change addressing an issue)
+- [ ] New feature (non-breaking change adding functionality)
+- [ ] Breaking change (fix or feature causing existing functionality to break)
+- [ ] Documentation update
+
+## Testing
+<!-- Please describe the tests you ran to verify your changes -->
+- [ ] Test A
+- [ ] Test B
+
+## Checklist
+- [ ] My code follows the style guidelines of this project
+- [ ] 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
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -2,30 +2,39 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment include:
+Examples of behavior that contributes to a positive environment:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes
 * Focusing on what is best for the community
-* Showing empathy towards other community members
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project team at
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,65 +1,78 @@
-# Contributing to wellcode-cli
+# Contributing to Wellcode CLI
 
-First off, thank you for considering contributing to wellcode-cli! It's people like you that make wellcode-cli such a great tool.
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
 
 ## Code of Conduct
 
-By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
 
-## How Can I Contribute?
+## 🐛 Bug Reports
 
-### Reporting Bugs
+**Before Submitting A Bug Report**
+* Check the [debugging guide](docs/debugging.md)
+* Check if the issue has already been reported
+* Collect information about the bug:
+  * Stack trace
+  * OS and version
+  * Python version
+  * Steps to reproduce
 
-This section guides you through submitting a bug report for wellcode-cli. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+**How Do I Submit A (Good) Bug Report?**
+Create an issue using the bug report template.
 
-- Use a clear and descriptive title for the issue to identify the problem.
-- Describe the exact steps which reproduce the problem in as many details as possible.
-- Provide specific examples to demonstrate the steps.
+## 🚀 Feature Requests
 
-### Suggesting Enhancements
+**Before Submitting An Enhancement**
+* Check if there's already a similar feature request
+* Determine which repository the enhancement should be suggested in
+* Perform a cursory search to see if the enhancement has already been suggested
 
-This section guides you through submitting an enhancement suggestion for wellcode-cli, including completely new features and minor improvements to existing functionality.
+## 🔄 Pull Request Process
 
-- Use a clear and descriptive title for the issue to identify the suggestion.
-- Provide a step-by-step description of the suggested enhancement in as many details as possible.
-- Provide specific examples to demonstrate the steps.
+1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md)
+2. Follow the [styleguides](#styleguides)
+3. After you submit your pull request, verify that all status checks are passing
 
-### Pull Requests
-
-- Fill in the required template
-- Do not include issue numbers in the PR title
-- Include screenshots and animated GIFs in your pull request whenever possible.
-- Follow the Python style guide.
-- Include thoughtfully-worded, well-structured tests.
-- Document new code based on the Documentation Styleguide
-- End all files with a newline
-
-## Styleguides
+## 📝 Styleguides
 
 ### Git Commit Messages
 
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Limit the first line to 72 characters or less
-- Reference issues and pull requests liberally after the first line
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters
+* Reference issues and pull requests liberally after the first line
+* Consider starting the commit message with an applicable emoji:
+    * 🎨 `:art:` when improving the format/structure of the code
+    * 🐎 `:racehorse:` when improving performance
+    * 📝 `:memo:` when writing docs
+    * 🐛 `:bug:` when fixing a bug
+    * 🔥 `:fire:` when removing code or files
 
 ### Python Styleguide
 
-All Python code must adhere to the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
+* Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/)
+* Use type hints
+* Write docstrings for all public methods
+* Use meaningful variable names
 
 ### Documentation Styleguide
 
-- Use [Markdown](https://daringfireball.net/projects/markdown/).
-
-## Additional Notes
+* Use [Markdown](https://daringfireball.net/projects/markdown/)
+* Reference functions and classes in backticks: \`func()\`
+* Document all functions and classes
 
-### Issue and Pull Request Labels
+## 🏷️ Issue and Pull Request Labels
 
-This section lists the labels we use to help us track and manage issues and pull requests.
+| Label name | Description |
+| --- | --- |
+| `bug` | Confirmed bugs or reports that are very likely to be bugs |
+| `enhancement` | Feature requests |
+| `documentation` | Documentation improvements |
+| `good first issue` | Good for newcomers |
+| `help wanted` | Extra attention is needed |
 
-* `bug` - Issues that are bugs.
-* `enhancement` - Issues that are feature requests.
-* `documentation` - Issues or pull requests related to documentation.
-* `good first issue` - Good for newcomers.
+## ⭐ Getting Help
 
-Thank you for contributing to wellcode-cli!
+* Join our [Discord community](https://discord.gg/wellcode)
+* Check out the [documentation](https://docs.wellcode.ai)
+* Email us at support@wellcode.ai
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@
   <a href="https://pypi.org/project/wellcode-cli/"><img src="https://img.shields.io/pypi/v/wellcode-cli.svg" alt="PyPI version"></a>
   <a href="https://pypi.org/project/wellcode-cli/"><img src="https://img.shields.io/pypi/pyversions/wellcode-cli.svg" alt="Python versions"></a>
   <a href="https://github.com/wellcode-ai/wellcode-cli/blob/main/LICENSE"><img src="https://img.shields.io/github/license/wellcode-ai/wellcode-cli.svg" alt="License"></a>
+  <a href="https://github.com/wellcode-ai/wellcode-cli/actions"><img src="https://github.com/wellcode-ai/wellcode-cli/workflows/tests/badge.svg" alt="Tests"></a>
+  <a href="https://codecov.io/gh/wellcode-ai/wellcode-cli"><img src="https://codecov.io/gh/wellcode-ai/wellcode-cli/branch/main/graph/badge.svg" alt="Coverage"></a>
 </p>
 
 ## 🚀 Installation
@@ -100,6 +102,22 @@ wellcode-cli
 - Issues: https://github.com/wellcode-ai/wellcode-cli/issues
 - Email: support@wellcode.ai
 
+## 📄 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## 💖 Contributors
+
+Thanks goes to these wonderful people:
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- Add contributors here -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
 ## 📄 License
 
-MIT License - see LICENSE file for details
+MIT License - see [LICENSE](LICENSE) file for details
diff --git a/docs/debugging.md b/docs/debugging.md
@@ -0,0 +1,101 @@
+# Debugging Guide
+
+## Common Issues and Solutions
+
+### Installation Issues
+
+#### Package Not Found
+```bash
+pip install wellcode-cli fails with "Package not found"
+```
+**Solution:**
+- Verify you're using Python 3.8 or higher
+- Check your pip version: `pip --version`
+- Try upgrading pip: `python -m pip install --upgrade pip`
+
+#### Permission Errors
+```bash
+Permission denied when installing package
+```
+**Solution:**
+- Use a virtual environment
+- Or install with user flag: `pip install --user wellcode-cli`
+
+### Configuration Issues
+
+#### GitHub Authentication
+```
+Error: Could not authenticate with GitHub
+```
+**Solution:**
+1. Verify your GitHub App installation
+2. Run `wellcode-cli config` again
+3. Check organization permissions
+
+#### API Key Issues
+```
+Error: Invalid API key
+```
+**Solution:**
+1. Verify API keys in `~/.wellcode/config.json`
+2. Regenerate API keys if necessary
+3. Run `wellcode-cli config` to reconfigure
+
+### Runtime Issues
+
+#### High Memory Usage
+If the CLI is using too much memory:
+1. Reduce date range in analysis
+2. Use `--limit` option if available
+3. Check for memory leaks in custom scripts
+
+#### Slow Performance
+If commands are running slowly:
+1. Enable debug logging: `export WELLCODE_DEBUG=1`
+2. Check network connectivity
+3. Verify API rate limits
+
+## Debug Mode
+
+Enable debug logging:
+```bash
+export WELLCODE_DEBUG=1
+wellcode-cli review
+```
+
+Debug log location:
+- Unix: `~/.wellcode/debug.log`
+- Windows: `%USERPROFILE%\.wellcode\debug.log`
+
+## Getting Support
+
+If you can't resolve an issue:
+
+1. Enable debug mode
+2. Reproduce the issue
+3. Collect logs
+4. Create a GitHub issue with:
+   - Steps to reproduce
+   - Debug logs
+   - Environment info
+   - Expected vs actual behavior
+
+## Environment Information
+
+Collect system information:
+```bash
+wellcode-cli debug
+```
+
+This provides:
+- Python version
+- OS details
+- Package versions
+- Configuration status
+
+## Contributing Debug Improvements
+
+Found a common issue? Help others:
+1. Document the solution
+2. Add to this guide
+3. Submit a PR
diff --git a/docs/styleguide.md b/docs/styleguide.md
