Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (44 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 1.4 KB
Raw

Contributing to api.zig

Thank you for your interest in contributing to api.zig! We welcome contributions from the community.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/api.zig.git
  3. Create a branch: git checkout -b feature/my-feature

Development Setup

Make sure you have Zig 0.15.0 or later installed:

zig version

Build and test:

zig build
zig build test

Making Changes

  1. Write your code
  2. Add tests for new functionality
  3. Ensure all tests pass: zig build test
  4. Format your code (Zig's formatter is built-in)

Commit Guidelines

  • Use clear, descriptive commit messages
  • Reference issues when applicable: Fixes #123
  • Keep commits focused on a single change

Pull Request Process

  1. Update documentation if needed
  2. Add tests for new features
  3. Ensure CI passes
  4. Request review from maintainers

Code Style

  • Follow Zig's standard style conventions
  • Use meaningful variable and function names
  • Add doc comments for public functions using ///
  • Add module documentation using //!

Reporting Issues

  • Use the issue templates provided
  • Include Zig version and OS
  • Provide minimal reproduction steps

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Questions?

Open a discussion or issue on GitHub.

Thank you for contributing! 🎉