Contributing

We welcome contributions to the Moribito project! This guide outlines how to contribute to the project.

Getting Started

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Setup

See Development Setup for detailed instructions on setting up the development environment.

Code Guidelines

• Follow Go best practices and idiomatic patterns
• Run make fmt before committing any changes to ensure proper code formatting
• Write tests for new functionality using table-driven tests when possible
• Document public APIs and complex logic
• Use meaningful commit messages

Testing

Always test your changes:

# Run tests
make test

# Run all CI checks (includes formatting, linting, testing, and building)
make ci

Documentation

When making changes that affect user-facing functionality:

1. Update the relevant documentation in the docs/ folder
2. Update the main README.md if necessary
3. Suggest changes to documentation when appropriate

License

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