Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
121 lines (89 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

121 lines (89 loc) · 2.6 KB

Contributing to Spry DALEC Packages

Thank you for your interest in contributing to the Spry DALEC packaging project!

How to Contribute

Reporting Issues

If you encounter any issues with the packages:

  1. Check if the issue already exists in the Issues section
  2. If not, create a new issue with:
    • A clear title and description
    • Steps to reproduce the problem
    • Expected vs actual behavior
    • Your operating system and version
    • Package version you're using

Submitting Changes

  1. Fork the repository
  2. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test your changes locally: 
    make build-all
  5. Commit your changes with a clear message: 
    git commit -m "Add: description of your changes"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Create a Pull Request

Development Setup

Prerequisites

  • Docker with BuildKit support
  • Docker Buildx
  • Make (optional, for convenience)
  • Deno (for local testing)

Environment Variables

This project requires authentication to download dependencies and compile the binary from the Spry repository. You must set the following environment variables:

# GitHub Personal Access Token (Classic or Fine-grained)
export GH_TOKEN="your_github_token"

# Auth token for Deno to fetch private raw modules
export DENO_AUTH_TOKENS="${GH_TOKEN}@raw.githubusercontent.com"

The tokens are required by make test, make build-all, and make download-deps.

Building Locally

# Build all packages
make build-all

# Build specific platform
make build-jammy
make build-bookworm
make build-windows

# Compile locally with Deno
make compile-local

Testing

# Test the compiled binaries
make test

# Install locally for testing
make install

# Uninstall
make uninstall

Code Style

  • Use clear, descriptive commit messages
  • Follow YAML best practices in DALEC specs
  • Keep the README.md up to date
  • Document any new features or changes

Pull Request Guidelines

  • Keep PRs focused on a single feature or fix
  • Update documentation as needed
  • Ensure all builds pass
  • Reference any related issues

Questions?

If you have questions, feel free to:

License

By contributing, you agree that your contributions will be licensed under the MIT License.