CONTRIBUTING.md

Contributing

We welcome contributions to this project.

Getting started

1. Fork the repository

   Look at the fork a repo github documentation to learn how to fork a repository.

2. Clone the repository

   Once forked, clone the repository to your machine.

   git clone [email protected]:ismaelmartinez/generator-compass-event-catalog.git

3. Install the dependencies

   The project uses pnpm as the package manager.

   pnpm install

Developing

It uses vitest for testing.

pnpm test

You can link the project to your EventCatalog to test your generator.

npm link

After linking, then you can navigate to your EventCatalog directory and link back the package.

npm link @ismaelmartinez/generator-atlassian-compass-event-catalog

Then, in the this generator project, you can run the build command to build the project.

pnpm run build

Finally, you can run the generate command in your EventCatalog project as you will do when using the package.

npm run generate

You should be ready to start developing with the generator. Open and issue if you find any problems.

EventCatalog uses EventCatalog SDK to interact with the Catalog.

You can also explore the get started building compass apps to learn more about the Compass API. I haven't explore it yet.