15c7fe3005
Eating your own dog food https://en.wikipedia.org/wiki/Eating_your_own_dog_food can be a good practice to show quality of this repo.
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
# Is It Maintained?
|
|
|
|
Monitoring open source projects activity.
|
|
[](http://isitmaintained.com/project/mnapoli/IsItMaintained "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/mnapoli/IsItMaintained "Percentage of issues still open")
|
|
|
|
|
|
|
|
## Metrics
|
|
|
|
- Issue median closing time
|
|
- Percentage of open issues
|
|
|
|
Not all issues are taken into account:
|
|
|
|
- Issues with labels like "feature", "enhancement", "duplicate"… are ignored
|
|
- For the issue median closing time issues older than 6 months are ignored
|
|
- ~~Issues from collaborators are ignored~~ (GitHub updated their API and it's not possible anymore)
|
|
|
|
Ideas:
|
|
|
|
- Reactivity: issue average acknowledgement time (i.e. first comment after the issue was open)
|
|
|
|
Dropped ideas:
|
|
|
|
- Release frequency: depends a lot on the project, hard to say a frequency is "good" or "bad" ([#2](https://github.com/mnapoli/Maintained/issues/2))
|
|
- Last commit date (from all branches): same as [#2](https://github.com/mnapoli/Maintained/issues/2)
|
|
|
|
## Run
|
|
|
|
$ composer install
|
|
$ bower install
|
|
$ php -S 0.0.0.0:8000 -t web web/index.php
|
|
|
|
The first time a badge is generated takes a few seconds, then it is cached. Be patient.
|
|
|
|
GitHub has an API rate limit that is reached very easily. To circumvent that, you can generate an
|
|
API token (https://github.com/settings/applications) and set it in `parameters.php`.
|
|
|
|
## Commands
|
|
|
|
- `bin/console stats:show user/repository`: shows the statistics for a repository (skips the cache)
|
|
- `bin/console cache:clear`: clears all the caches
|
|
- `bin/console cache:warmup`: warmup the caches
|
|
|
|
## Requirements
|
|
|
|
- PHP 7.0
|
|
- [Puli](http://puli.io) installed
|
|
- GD extension
|
|
|
|
## Feature requests
|
|
|
|
Issues are disabled for now on this repository because they were filling up with feature requests. If you want a feature to be added, pull requests are welcome.
|