https://github.com/cutenode/retrogen
A tool for generating retrospectives for GitHub activity.
https://github.com/cutenode/retrogen
Last synced: about 1 year ago
JSON representation
A tool for generating retrospectives for GitHub activity.
- Host: GitHub
- URL: https://github.com/cutenode/retrogen
- Owner: cutenode
- License: mit
- Created: 2022-04-18T17:20:33.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T13:34:30.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T14:57:13.241Z (about 1 year ago)
- Language: JavaScript
- Size: 268 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# retrogen
A tool for generating retrospectives for GitHub activity.
### Pacakges
- [@retrogen/core](./core/): The core functionality of retrogen.
- [@retrogen/generate](./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`](./core/) and [`@retrogen/templates`](./templates/) modules.
- [@retrogen/templates](./templates/): Templates to convert data from [`@retrogen/core`](./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. `dotenv` doesn't currently support workspaces, so you'll need to do work from each workspace rather than from the root of the project.
### 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.