Skip to content

README.md

Latest commit

 

History

History
63 lines (41 loc) · 1.81 KB

README.md

File metadata and controls

63 lines (41 loc) · 1.81 KB

devStats

Transform your GitHub activity into compelling proof of work. Showcase your skills with beautiful analytics and insights.

Description

devStats is an open-source tool designed to provide actionable insights into your development process. By gathering and analyzing metrics from codebases, devStats helps teams improve productivity, code quality, and project progress. Whether you’re a solo developer or part of a large team, devStats empowers you to make data-driven decisions.

Table of Contents

  1. Key Features
  2. Configuration
  3. Contributing
  4. License
  5. Contact
  6. Project Status

Key Features

  • Automated code analysis
  • Integration with GitHub
  • Metrics dashboards with charts & graphs
  • Customizable reports (daily, weekly, monthly)
  • AI-generated README.md
  • Code review insights (e.g., average PR review time)
  • AI-generated portfolio based on GitHub
  • AI-powered recommendations for improving team efficiency

Configuration

Create a .env file to store environment variables:

Refer to .env.example for guidance.

You can also customize the tool via config.yaml for things like ignored files, time ranges, and more.

Contributing

Contributions are welcome! To get started:

  1. Fork the repository
  2. Create a branch (git checkout -b feature/your-feature)
  3. Commit your changes (git commit -m "Add feature XYZ")
  4. Push to the branch (git push origin feature/your-feature)
  5. Submit a pull request 🚀

License

Licensed under the MIT License.

Contact

👤 Muhammed Sanjid 📧 sanjid357@gmail.com

Project Status

  • Alpha: Actively developing core features
  • Beta: Planned (coming soon!)

Stay tuned for updates, and feel free to contribute!