CONTRIBUTING.md

Contributing

Ways to contribute

You can help the project several ways

• Give us feedback on your experience with the ecosystem through the Moose slack community or Github Discussions
• Report bugs through Github Issues
• Propose changes by opening an RFD
• Give you perspective on an existing opened RFD
• Contribute to the documentation
• Contribute features and functionality by picking up issues. A good way to start is to pick up issues marked as Good First Issue

Code Contributions

Setup

Requirements:

• Rust: We recommend using rustup to manage your rust toolchain
• Node: We recommend using nvm to manage your node versions
• Pnpm
• TurboRepo: pnpm install turbo --global

$ pnpm install

Build

turbo build

Debug

To debug the CLI, create a .vscode/launch.json & change the inputs according to your needs.

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "lldb",
            "request": "launch",
            "name": "CLI (OSX)",
            "preLaunchTask": "CLI build",
            "program": "${workspaceRoot}/target/debug/moose-cli",
            "cwd": "${input:enterMooseDir}",
            "args": [
                "${input:enterCommand}",
                // "${input:enterOptions}"
            ]
        }
    ],
    "inputs": [
        {
            "id": "enterMooseDir",
            "type": "promptString",
            "description": "Directory of your moose app",
            "default": "${env:HOME}"
        },
        {
            "id": "enterCommand",
            "type": "pickString",
            "description": "CLI command to run",
            "options": ["init", "dev", "update", "stop", "clean", "help"],
            "default": "dev"
        },
        {
            "id": "enterOptions",
            "type": "promptString",
            "description": "Extra options for the command",
            "default": ""
        }
    ]
}

Moose Libs

Moose libraries are in packages folder. We use local links to make changes to the libraries & test with local Moose projects. Example of the dev workflow for updating ts-moose-lib (similar for other packages like ts-connector-*)

1. Make your change in ts-moose-lib source code.
2. Build ts-moose-lib.
   1. If you're on VSCode/Cursor, open the command prompt with Cmd + Shift + P, select Tasks: Run Task, then select Build All The build tasks are defined in .vscode/tasks.json.
   2. If you want to build from command line, run pnpm --filter=@514labs/moose-lib run build.
3. Link ts-moose-lib to a local Moose project.
   1. From ts-moose-lib directory, run npm link .
   2. From ts-moose-lib, verify with npm list -g to see the global package is actually pointing to your local ts-moose-lib.
   3. From the moose project, run npm install to pull in all dependencies.
   4. From the moose project, run npm link @514labs/moose-lib. This will look at your global packages and use that instead (which is pointing to your local ts-moose-lib). Make sure to use the package name you saw from npm list -g.
   5. From the moose project, verify with ls -la node_modules/@514labs to see the package is actually pointing to your local ts-moose-lib.
4. Iterate. Now that the link is setup, anytime you change ts-moose-lib, you just have to build (step 2), and the local moose moose project will automatically use the local ts-moose-lib.
5. To unlink, from your moose project, run npm unlink @514labs/moose-lib then run npm install @514labs/moose-lib to pull in from npm registry.
6. To remove the global ts-moose-lib, run npm unlink -g @514labs/moose-lib from the ts-moose-lib folder.

Versioning Scheme.

We use semantic versioning to denote versions of the different components of the system.

We have automation that helps keep a really high cadence as we develop the initial version of the framework and ecosystem.

We might change how we release later in the lifecycle of the project.

Currently we release every time code that changes the framework or the CLI is merged to the main branch. We are releasing from the trunk.

• By Default, every commit on main will increase the patch version. ie in x.y.(z+1)
• if the commit message contains [minor-version], the bot will pick up on it and will set the version of the released packages as x.(y + 1).0
• if the commit message contains [major-version], the bot will pick up on it and will set the version of the released packages as (x+1).0.0
• if the commit message contains [no-release] in the commit message. We do not release anything.

We ensure that we don't have conflicts as branches get merged in main by leveraging git linear history as well as the concurrency github actions concept to enforce order.