Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

71 lines (55 loc) · 2.17 KB

Contributing to @ocoda/event-sourcing

Thank you for considering contributing to this project! We appreciate your help in improving it. To make the process smooth, please follow these guidelines.

How to Contribute

Prerequisites

node: "^>=18.20.4"
pnpm: "^9.12.3"
# otherwise, your build will fail

Steps

  1. Fork the Repository
    Create a personal fork of the repository by clicking the “Fork” button.

  2. Clone your Fork
    Clone your forked repository locally:

    git clone https://github.com/@ocoda/event-sourcing.git

  3. Create a branch

    git checkout -b feature/your-feature-name

  4. Install the dependencies @ocoda/event-sourcing uses pnpm workspaces, so the dependencies need to be installed from the project root directory.

    pnpm install

  5. Start the docker container(s) When making changes to the core library situated under /packages/core there are no dependencies on any of the docker containers. However, if changing one of the integration packages situated under /packages/integration, so will need to spin up one of the databases in order to test your changes. For example:

    docker compose up -d mariadb

  6. Make Your Changes Ensure your code follows the project’s coding standards and passes tests.

  7. Lint and format your changes To make sure your changes are in accordance to the styles used in this repository and pass the CI checks, you can run the linting and formatting steps.

    pnpm lint format

  8. Commit Your Changes Write clear and concise commit messages:

    git commit -m "Add description of your changes"

    [!IMPORTANT]
    When making changes to the core library or one of the integrations, make sure to include a changeset.

    pnpm exec changeset

  9. Push to Your Fork Push your changes to your forked repository:

    git push origin feature/your-feature-name

  10. Create a Pull Request Go to the original repository, and click the “New Pull Request” button. Fill in details about the changes and submit.