Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (46 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 1.94 KB

Contributing to Go Projects Toolkit

Thank you for your interest in contributing to the Go Projects Toolkit! This document provides guidelines and instructions for contributing.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with:

  • A clear and descriptive title
  • A detailed description of the problem
  • Steps to reproduce the issue
  • Expected behavior vs. actual behavior
  • Any relevant code snippets or error messages

Suggesting Enhancements

If you have an idea for a new feature or improvement:

  • Check if there's already an issue or pull request for it
  • Create a new issue describing your suggestion
  • Explain why the enhancement would be useful

Code Contributions

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Make your changes
  4. Ensure your code follows the existing style
  5. Add or update tests as necessary
  6. Update documentation if needed
  7. Submit a pull request

Code Style

  • Follow the official Go Code Review Comments
  • Use gofmt to format your code
  • Write clear, concise comments
  • Use meaningful variable and function names
  • Keep functions small and focused

Testing

  • Ensure all existing tests pass
  • Add new tests for any new functionality
  • Test your changes on multiple platforms if possible

Documentation

  • Update README files when adding new features
  • Keep documentation clear and concise
  • Include examples when appropriate

Pull Request Process

  1. Ensure your code compiles and passes tests
  2. Update the README.md with details of changes if applicable
  3. Increase the version number in any examples if needed
  4. Your pull request will be reviewed by maintainers
  5. Address any feedback during the review process

Questions?

If you have any questions about contributing, feel free to create an issue asking for clarification.

Thank you for helping make the Go Projects Toolkit better!