Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.24 KB

Contributing to github-webhook-impulse

Thank you for considering a contribution—your help keeps this repository healthy for every bobrapet Story.

This guide explains how we work in the github-webhook-impulse repository, from filing issues to sending patches.

How Can I Contribute?

Reporting Bugs

  • Search for an existing report under Issues.
  • If nothing matches, open a new issue with a clear description, reproduction steps, and both observed and expected behaviour.

Suggesting Enhancements

  • Start a thread in Discussions or file a feature request issue.
  • Document motivating use-cases, proposed config additions, and any compatibility considerations for existing Stories.

Pull Requests

  • Fork the repository and branch from main.
  • Keep changes focused; additive config should include manifest updates (Engram.yaml or Impulse.yaml) and README documentation.
  • Run the quality gates locally:
    • make lint
    • make test
    • make docker-build IMG=ghcr.io/<your-user>/github-webhook-impulse:dev when binaries or Dockerfile paths change
  • Open the PR with a summary, testing evidence, and any follow-up TODOs.

Development Workflow

Prerequisites

  • Go 1.26+
  • Docker (or another OCI-compatible builder)
  • make

Setup

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/<your-user>/github-webhook-impulse.git
  3. Enter the repo: cd github-webhook-impulse
  4. Install tooling: make lint-config
  5. Confirm builds and tests: make build && make test

Running Tests

make test

Commit Message Conventions

We use Conventional Commits so releases and change logs stay automated.

Examples:

  • feat: add new configuration option
  • fix: handle edge case in processing
  • docs: clarify configuration fields
  • chore: bump SDK to latest

Code of Conduct

Participation in this project is governed by the Contributor Covenant Code of Conduct. Report unacceptable behaviour to conduct@bubustack.com.