Skip to content

Commit 3c1ab09

Browse files
committed
Adding docs for repo, after porting it to the ISC org
1 parent 6195f31 commit 3c1ab09

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
# repo-score-py
1+
# repo-activity-score
2+
3+
The goal of this repository is to collect reference implementations of the [Repository Activity Score](https://patterns.innersourcecommons.org/p/repository-activity-score).
4+
5+
Currently we got only a single implementation (in Python), but are considering to add similar versions for JavaScript, Go and C#. Feel free to contribute other implementations! :)
6+
7+
## How to run this
8+
9+
TBD: how to run the current implementation
10+
11+
## Limitations
12+
13+
These implementations assume that the repositories for which you want to calculate the Repository Activity Score are hosted in GitHub i.e. the respective metadata is available via the GitHub Search API and GitHub stats/participation API.
14+
15+
However it should be possible with relatively low effort to adapt these implementations to other version control systems.
16+
17+
## Educational purposes only
18+
19+
These implementations are provided as reference implementations and with that for educational purposes only.
20+
21+
## License
22+
23+
[MIT License](LICENSE).

0 commit comments

Comments
 (0)