retrogen

A tool for generating retrospectives for GitHub activity.

Pacakges

• @retrogen/core: The core functionality of retrogen.
• @retrogen/generate: A tool that generates Markdown retros for GitHub users and organizations. This is the all-in-one solution for retrogen that incorporates both the @retrogen/core and @retrogen/templates modules.
• @retrogen/templates: Templates to convert data from @retrogen/core into human-readable markdown.

Contributing and Development.

To contribute, you'll need to get a GitHub Personal Access Token and add it to a .env file in eacch workspace that you're going to work in. We're using Node.js's localEnvFile feature.

Scripts

As a monorepo, every package has the same set of sub-scripts. This enables us to alias those to monorepo-level scripts. The following aliases are provided:

• lint: runs each package's linter.
• lint:fix: runs each package's linter and fix any issues that can be automatically fixed.
• test: runs each package's tests. Currently there are no tests, but the commands and devDeps are set up.
• coverage: runs each package's test coverage. Since there are currently no tests, again this will do nothing despite being properly configured.
• examples: runs each package's examples and logs the raw output.
• examples:output: runs each package's examples and writes the output to a file.