The CQAA (Code Quality Aromatherapy Assistant) is a unqiue and ingenious tool that uses the art of aromatherapy together with code analysis. The tool analyzes your Github repo's code quality and generates a custom "Fragrance profile" based on many things including metrics, providing you with olfactory feedback in your code's health! Features
- Comprehensive code analysis (complexity, maintainability, comment ratio, and more)
- Custom fragrance profile generation based on code metrics
- Detailed visualizations of key code quality indicators
- Actionable suggestions for code improvement
- Automated PR comments with analysis summaries
- Clone this repository: git clone https://github.com/yourusername/code-quality-aromatherapy-assistant.git
- Install the required dependencies using: pip install -r requirements.txt
- Lastly Set up your GitHub token as an environment variable: export GITHUB_TOKEN=your_github_token_here
-
Add the
.github/workflows/code_quality.ymlfile to your repository. -
Push changes or create a pull request to trigger the analysis.
-
View the generated report and visualizations in the GitHub Actions artifacts.
-
For pull requests, a summary comment will be automatically added.
The CQAA creates a custom fragrance profile based on the code's metrics. Each scent represent a different aspect based on you code quality: lavender: Calm, clean code peppermint: Refreshing, efficient code lemon: Clean, well-documented code eucalyptus: Complex but powerful code rosemary: Memory-intensive code tea tree: Bug-free code frankincense: Legacy code sandalwood: Stable, reliable code
We welcome all contributions big and small! feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
- Thanks to all the developers who understand the importance of code quality
- Inspired by the calming effects of aromatherapy and the satisfaction of clean code
Remember, the nose knows good code! Happy coding and happy sniffing! 😸