Thank you for your interest in contributing to this Go project. This guide will help you get started with the contribution process.
- Fork the repository
- Clone your fork:
git clone git@github.com:0xnu/mothistory.git
- Create your feature branch:
git checkout -b feature-name
- Ensure you have Zig installed (latest version recommended)
- Make your changes following the project's coding standards
- Add or update tests as necessary
- Run tests locally to ensure they pass
- Commit your changes:
git commit -s -m 'Add feature-name'
- Push to the branch:
git push origin feature-name
- Create a pull request
To build and run tests:
## add tests
- Ensure your code passes all tests
- Update documentation for any changed functionality
After your pull request is merged, you can safely delete your branch.
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!