Skip to content

Contributing to Pipelex

Thank you for your interest in contributing! Contributions are very welcome. We appreciate first time contributors and we are happy help you get started. Join our community on Discord and feel free to reach out with questions in the #code-contributions and #pipeline-contributions channels.

Everyone interacting in Discord, codebases, mailing lists, events, or any other Pipelex activities is expected to follow the Code of Conduct. Please review it before getting started.

Most of the issues that are open for contributions are tagged with good first issue or help-welcome. If you see an issue that isn't tagged that you're interested in, post a comment with your approach, and we'll be happy to assign it to you. If you submit a fix that isn't linked to an issue you're assigned, there's chance it won't be accepted. Don't hesitate to ping the Pipelex team on Discord to discuss your choice of issue before getting to work.

We are open to contributions in all areas of our core Pipelex library:

  • Bug fixes: Crashes, incorrect output, performance issues
  • Feature: New API, CLI flag, module, test coverage
  • Refactor: Rethink architecture
  • Chore: Dependency updates, config tweaks, file renames
  • Docs: Main docs, SWE Agent rules, tutorials, examples, READMEs
  • CI/CD: GitHub Actions, packaging, release tooling

Requirements

  • Node.js ≥22
  • pnpm ≥10.18.1

Contribution Process

  1. Fork and clone the repository
  2. Fork the n8n-nodes-pipelex repository

  3. Clone your fork locally

  4. Install dependencies 

    make install
    This will install pnpm 10.18.1 (if needed) and all project dependencies.

  5. Run initial checks 

    make check
    This runs linting, builds the package, and validates the package structure.

  6. Create a feature branch

  7. Branch format: category/short_slug
  8. Categories: feature, fix, refactor, docs, cicd, or chore

  9. Example: feature/add-timeout-parameter or fix/credential-validation

  10. Make your changes

  11. Write clean, readable code following existing patterns
  12. Keep commits atomic and well-described

  13. Update documentation if needed

  14. Run quality checks before submitting 

    make check

  15. Push to your fork 

    git push origin your-branch-name

  16. Open a Pull Request

  17. Link to an existing Issue (no needs triage label)
  18. Fill in the PR title and description using the template
  19. Mark as Draft until CI checks pass

  20. CI tests will run automatically

  21. Code review and merge

    • Maintainers will review your code
    • Respond to feedback if required
    • Once approved and CI passes, your contribution will be merged!

License

  • CLA – The first time you open a PR, the CLA-assistant bot will guide you through signing the Contributor License Agreement. The process signature uses the CLA assistant lite.
  • Code of Conduct – Be kind. All interactions fall under CODE_OF_CONDUCT.md.