Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (45 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 1.64 KB

Contributing to Mochi

Thank you for your interest in contributing to Mochi! 🍡

How to Contribute

Reporting Issues

  • Use the issue tracker to report bugs or suggest features
  • Check existing issues first to avoid duplicates
  • Provide clear descriptions and steps to reproduce (for bugs)

Suggesting Features

  • Open an issue with the enhancement or feature request label
  • Describe the feature and why it would be valuable
  • Discuss before implementing large features

Code Contributions

  1. Fork the repository
  2. Create a branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes
    • Follow Go best practices
    • Add tests for new features
    • Update documentation as needed
  4. Commit your changes: 
    git commit -m "Add: description of your changes"
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Open a Pull Request

Code Style

  • Follow standard Go formatting (go fmt)
  • Write clear, self-documenting code
  • Add comments for complex logic
  • Keep functions focused and small

Development Setup

Note: Setup instructions will be added as development progresses.

Questions?

License

By contributing, you agree that your contributions will be licensed under the GNU General Public License v3.0.

Thank you for helping make Mochi better! 🙏