Contributor Guide

Thank you for your interest in contributing to Lula! We welcome all contributions and are grateful for your help. This guide outlines how to get started with contributing to this project.

Table of Contents

• Contributor Guide
  • Table of Contents
  • Code of Conduct
  • Getting Started
    • Setup
  • Submitting a Pull Request
    • PR Requirements
  • Coding Guidelines
  • Running Tests
    • Run Tests Locally
    • Running Development Version Locally
  • Contact

Code of Conduct

Please follow our Code of Conduct to maintain a respectful and collaborative environment.

Getting Started

• Repository: https://github.com/defenseunicorns/lula/
• npm package: https://www.npmjs.com/package/lula2
• Required Node version: >=22.0.0

Setup

1. Fork the repository.
2. Clone your fork locally: git clone https://github.com/your-username/lula.git.
3. Install dependencies: pnpm i.
4. Create a new branch for your feature or fix: git checkout -b my-feature-branch.

Submitting a Pull Request

1. Create an Issue: For significant changes, please create an issue first, describing the problem or feature proposal. Trivial fixes do not require an issue.
2. Commit Your Changes: Make your changes and commit them. All commits must be signed.
3. Run Tests: Ensure that your changes pass all tests by running npm test.
4. Push Your Branch: Push your branch to your fork on GitHub.
5. Create a Pull Request: Open a pull request against the main branch of the Lula repository. Please make sure that your PR passes all CI checks.

PR Requirements

• PRs must be against the main branch.
• PRs must pass CI checks.
• All commits must be signed.
• PRs should have a related issue, except for trivial fixes.

We take PR reviews seriously and strive to provide a great contributor experience with timely feedback. To help maintain this, we ask external contributors to limit themselves to no more than two open PRs at a time. Having too many open PRs can slow down the review process and impact the quality of feedback.

Coding Guidelines

Please follow the coding conventions and style used in the project. Use ESLint and Prettier for linting and formatting:

• Check formatting: pnpm run lint
• Fix formatting: pnpm run format
• If regex is used, provide a link to regex101.com with an explanation of the regex pattern.
• Do not use emoji in logs or comments, as it can be distracting and is not consistent with the project's style.

Running Tests

Run Tests Locally

• Run all unit tests: pnpm test
• Run all integration tests: pnpm run test:integration

Running Development Version Locally

1. Run pnpm run build to build the package.
2. Run npx lula2 to use the local version of Lula from the root of the repository.

:::tip Make sure to re-run pnpm run build after you modify any of the lula source files. :::

Contact

For any questions or concerns, please open an issue on GitHub or contact the maintainers.