Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.15 KB

Contributing Guide

Thank you for your interest in contributing to this Go project. This guide will help you get started with the contribution process.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone git@github.com:0xnu/mothistory.git
  3. Create your feature branch: git checkout -b feature-name
  4. Ensure you have Zig installed (latest version recommended)

Making Changes

  1. Make your changes following the project's coding standards
  2. Add or update tests as necessary
  3. Run tests locally to ensure they pass
  4. Commit your changes: git commit -s -m 'Add feature-name'
  5. Push to the branch: git push origin feature-name
  6. Create a pull request

Building and Testing

To build and run tests:

## add tests

Submitting Changes

  • Ensure your code passes all tests
  • Update documentation for any changed functionality

After your pull request is merged, you can safely delete your branch.

Reporting Issues

If you find a bug or have a suggestion, please open an issue. Provide:

  • Steps to reproduce
  • Expected behaviour
  • Actual behaviour
  • Your environment (Zig version, OS, etc.)

Thank you for contributing!