Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (75 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

109 lines (75 loc) · 2.14 KB

Contributing

Thank you for your interest in contributing to our project!

How to Contribute

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Sign your commits with DCO: 
    git commit -s -m "Your commit message"
  5. Push to your fork and submit a pull request

Developer Certificate of Origin

We use the Developer Certificate of Origin (DCO) in lieu of a Contributor License Agreement (CLA) for all contributions to this project. DCO is a legally binding statement that asserts that you are the creator of your contribution and that you wish to allow us to use it in this project.

When you contribute to this repository with a pull request, you need to sign-off that you agree to the DCO. You do this by adding a Signed-off-by line to your commit messages containing your name and email:

git commit -s -m "Your commit message"

This will automatically add a sign-off message to your commit. Alternatively, you can manually add:

Signed-off-by: John Doe <john.doe@example.org>

Code Guidelines

  • Keep code clean and simple
  • Follow existing code style
  • Update documentation if needed

Development Setup

Prerequisites

  • Go 1.21+
  • Node.js 22+
  • Docker

Installation Steps

  1. Clone the repository:

    git clone https://github.com/getprobo/probo.git
cd probo

  2. Install Go dependencies:

    go mod download

  3. Install JavaScript dependencies:

    npm ci

  4. Build the project:

    make build

  5. Start docker containers:

    make stack-up

  6. Start the development servers:

    # In one terminal - start the API server
bin/probod -cfg-file cfg/dev.yaml

# In another terminal - start the frontend
npm -w @probo/console run dev

The application should now be running at http://localhost:3000

For detailed information about all Docker services in the development stack, see Docker Services Documentation.

Need Help?

Create an issue if you:

  • Found a bug
  • Have a feature request
  • Need help with something

Thank you for contributing!