Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

Contributing

Thank you for your interest in contributing to Jumpstarter!

Getting Help

Getting Started

  1. Fork the repository

  2. Clone your fork locally

  3. Set up the development environment: make sync and make test

  4. Make changes on a new branch

  5. Test your changes thoroughly

  6. Submit a pull request

Contribution Guidelines

Making Changes

  • Focus on a single issue

  • Follow existing code style

  • Add tests and update documentation

Commit Messages

  • Use clear, descriptive messages

  • Reference issue numbers when applicable

  • Follow conventional commit format when possible

Pull Requests

  • Provide a clear description

  • Link to relevant issues

  • Ensure all tests pass

Types of Contributions

Code Contributions

We welcome bug fixes, features, and improvements to the core codebase.

Contributing Drivers

To create a new driver scaffold:

$ ./__templates__/create_driver.sh driver_package DriverClass "Your Name" "your.email@example.com"

For private drivers, consider forking our jumpstarter-driver-template.

Test your driver: make pkg-test-${package_name}

Contributing Documentation

Jumpstarter uses Sphinx with Markdown. Build and preview locally:

$ make docs-serve

Documentation recommended practices:

  • Use clear, concise language

  • Include practical examples

  • Break up text with headers, lists, and code blocks

  • Target both beginners and advanced users