Project Onboarding Checklist

[rocketstack-matt]

Feature Request

Description of Problem:

Whilst adding the visualizer project into the monorepo, we thought of numerous tasks that should have been completed post merge, such as adding the project into the workspace, readme, codeowners, etc.

Solution:

We should create a new issue type for adding projects with a checklist for contributors to complete.

[Thels]

• .github/CODEOWNERS is updated to add your new module.
• Ensure workflow actions are added to .github/workflows that build/verify the module for any PR's with it in its blast radius. For example if your module depends on shared it should trigger build/tests on shared changes.
• README.md updated with new module and owners. Refer to the URL
• If it's a typescript module - add into the root level package.json under workspaces: so that we can hoist shared dependencies and allow root level installs/builds etc.
• New module should have a README.md documenting what the module does - how to develop for it and any other sort of contribution guidelines.
• If the new module requires a new label for PR clarity ( PR Clarity - Labelling #783 ) - add this into .github/labeler.yml and if this is a new label please manually create it on GitHub.

[Thels]

Assigning to myself - will get this added onto a new issue type.