Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (64 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

77 lines (64 loc) · 2.57 KB

Contributing

We welcome your input! We want to make contributing to this project as easy and transparent as possible. You can contribute by:

  • Reporting bugs
  • Discussing the current state of the code
  • Submitting fixes
  • Proposing new features
  • Becoming a maintainer

Development Workflow

We use Github Flow for collaboration. All changes happen through pull requests (PRs). In the early stages, changes are driven directly by us, but changes should typically be reflected through PRs.

  1. Fork this repository and clone your fork locally.
  2. Create a new branch from master:
git checkout -b feature/my-new-feature-or-issue-id
  1. Make your changes:
  • Add tests for any new functionality.
  • Update documentation if APIs or behaviors change.
  1. Ensure the following before submitting:
  • Your code passes the test suite.
  • Your code adheres to the project's coding style.
  1. Open a pull request (PR) and describe your changes clearly.

We actively welcome and review pull requests, so don’t hesitate to contribute!

Reporting Bugs

We use GitHub Issues to track bugs and feature requests. To report a bug:

  1. Search existing issues first to avoid duplicates.
  2. If no similar issue exists, open a new issue with:
    • A clear and descriptive title.
    • Steps to reproduce the issue:
      • Include sample code if possible.
      • Be specific (e.g., system version, inputs, outputs).
    • Expected behavior vs. actual behavior.
    • Additional context, logs, or screenshots to help us diagnose the issue.

Please use the templates provided in the .github directory. Thorough bug reports help us fix issues faster. Thank you!

Submitting Changes via Pull Requests

Follow these steps to submit changes:

  1. Fork the repository and clone it locally.
  2. Create a branch for your changes:
git checkout -b feature/my-new-feature-or-issue-id
  1. Make your changes:
  • Add tests for new code.
  • Update documentation if necessary.
  1. Ensure your changes pass the test suite:
go test ./...
  1. Check your code formatting:
go fmt ./...
  1. Commit your changes with a descriptive message:
git commit -m "Add: Description of the feature or fix"
  1. Push to your fork:
git push origin feature/my-new-feature-or-issue-id
  1. Open a Pull Request targeting the master branch.

Please use the templates provided in the .github directory.

License

By contributing, you agree that your submissions are licensed under the MIT License.