Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.97 KB
Raw

Contributing to Wingman AI

Thanks for your interest in contributing! This document explains how to submit changes and report issues.

Getting Started

  1. Fork the repository
  2. Create a feature or fix branch from develop
  3. Make your changes
  4. Open a pull request against develop

Pull Request Rules

  • Every PR must be linked to a GitHub issue. Reference it in the PR description using Closes #123, Fixes #123, or Resolves #123. PRs without a linked issue cannot be merged.
  • Target the develop branch. Do not open PRs against main.
  • Rebase onto develop before requesting a review. We require linear history — merge commits are not allowed.
  • All commits are squash-merged. Your PR title and description become the final commit message, so make them clear and descriptive.
  • At least one approving review is required before a PR can be merged.

Reporting Bugs

Please use the Bug Report issue template. You will need to provide:

  • Your Wingman AI version
  • Your Wingman.yaml configuration file
  • Your settings.yaml file
  • A log file from the session where the bug occurred
  • Clear steps to reproduce the issue

Never include your secrets.yaml file. It contains API keys and other sensitive credentials.

All of these files can be found in your %APPDATA%/ShipBit/WingmanAI/ directory on Windows.

Feature Requests

Use the Feature Request issue template. Describe what you'd like to see and why it would be useful.

Major Features

If you're planning to develop a major feature or new integration, please reach out on Discord first. We want to make sure your work aligns with the project's direction and doesn't overlap with something already in progress.

Code of Conduct

Be respectful and constructive. We're all here to make Wingman AI better.