Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 1.72 KB

Contributing to gob

Thank you for your interest in gob. Your contributions are highly welcome.

Prerequisites

This project uses a Makefile to manage build scripts. You will need make installed to run these scripts. See Makefile for a list of possible commands and what they do.

You will need to have a go installation - ideally compatible with the project's current go version (see go.mod).

macOS

In order to use make, install apple developer tools.

Getting Started

# Clone the repository
git clone https://github.com/juanibiapina/gob.git
cd gob

# Initialize git submodules (required for testing)
git submodule update --init --recursive

Building

To build the project:

make build

Binary output: dist/gob

You can test the binary locally by running it directly:

./dist/gob --version

Testing

Requirements

  • BATS (included as git submodule)
  • jq (JSON processor)

Running Tests

# Run the test suite
make test

Tests are located in test/*.bats and verify end-to-end functionality of the CLI.

Making Changes

Changelog Updates

When making user-facing changes to the project:

  1. Update CHANGELOG.md under the [Unreleased] section
  2. Follow the Keep a Changelog format
  3. Use appropriate categories:
    • Added - New features
    • Changed - Changes to existing functionality
    • Deprecated - Soon-to-be removed features
    • Removed - Removed features
    • Fixed - Bug fixes
    • Security - Security improvements

Release Process

For information about the release process, see docs/releases.md.