Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (62 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

93 lines (62 loc) · 2.16 KB
Raw

Contributing to Podsy

Thank you for your interest in contributing to Podsy! This document provides guidelines and instructions for contributing to this project.

Development Setup

Prerequisites

  • Go 1.22 or higher
  • Podman installed
  • Git

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally:
git clone https://github.com/yourusername/Podsy.git
cd Podsy
  1. Add the original repository as an upstream remote:
git remote add upstream https://github.com/YacineMK/Podsy.git
  1. Create a new branch for your work:
git checkout -b feature/your-feature-name

Building and Testing

Building the Project

make build

This will compile the binary to the dist directory.

Formatting Code

make format

Running Tests

Before submitting a pull request, make sure to test your changes manually:

  1. Build the project
  2. Run the binary with your test compose files
  3. Verify that the commands work as expected

Submitting Changes

  1. Make your changes in your fork
  2. Add or update tests as necessary
  3. Run make format to ensure consistent code style
  4. Commit your changes with clear, descriptive commit messages
  5. Push your branch to your fork on GitHub
  6. Submit a pull request to the main repository

Pull Request Guidelines

  • Include a clear description of the changes and the problem they solve
  • Make sure all tests pass
  • Follow the existing code style
  • Keep pull requests focused on a single concern
  • Update documentation as necessary

Code Structure

  • cmd/: Command-line interface definitions using Cobra
  • internal/commands/: Implementation of command functionality
  • pkg/types/: Data structures and types used across the project
  • examples/: Example files and configurations

Versioning

This project follows Semantic Versioning. When creating a release:

  1. Update version number appropriately in relevant files
  2. Create a Git tag for the release
  3. Push the tag to GitHub to trigger the release workflow

License

By contributing to Podsy, you agree that your contributions will be licensed under the project's MIT License.