README

This project tries to gather information about open source contributions for a given organization.

Producing output files

First, make sure you installed dependencies, e.g. composer install.

HTML

There is some scripting in place to generate an HTML page based on the data. It also contains JSON-LD output that may be useful if the page is public at some point.

You may want to try the following command.

./contriblog html > contributions.html

RSS

There is also a way to produce RSS output.

You may want to try the following command.

./contriblog rss > rss.xml

Adding entries

• Use the helper, e.g. ./contriblog add, or
• Manually edit the YAML file, and process it with ./contriblog format to get it on the standard output.

YAML format

The YAML file tries to be self-explanatory. It tries to describe contributions thinking in possible future use of the data.

Types are CHAOSS Types of Contributions.

Contributions are sorted by date.

You may want to enable the git pre-commit hook, e.g. with git config core.hooksPath .githooks.

References

• Community Health Analytics Open Source Software, CHAOSS provides guidance about data measurement around open source software, but it also provides general guidance, that this project can use.
• CHAOSS Common Metrics Working Group (Common WG) contains more direct suggestions.

Credit

This project has been initially developed by Adapt.