Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.9 KB

Contributing to Go Client for Sanity

We're thrilled that you're interested in contributing to the Go client for Sanity! This document provides guidelines for contributions to the project.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

There are many ways you can contribute to our project:

  1. Submitting Bugs and Feature Requests: Bugs and feature requests can be submitted through the project's issue tracker. Please use a clear and descriptive title and provide a comprehensive description of the issue.

  2. Writing Code: We welcome your pull requests for bug fixes, features, and improvements. Here's how you can submit your code contributions:

    • Fork the repository.
    • Create a new branch for your feature (git checkout -b feature/YourFeature).
    • Write your code and add tests if applicable.
    • Ensure your code adheres to the project's coding standards.
    • Commit your changes (git commit -am 'Add a new feature').
    • Push to your branch (git push origin feature/YourFeature).
    • Open a pull request against the main branch.

  3. Documentation: Improving documentation, tutorials, or examples is a great way to contribute. Even small changes like fixing typos are appreciated.

  4. Reviewing Pull Requests: If you're interested in reviewing pull requests, please leave constructive feedback on open pull requests.

Development Environment

Set up your development environment as per the instructions in the README. This will help you test your changes and ensure consistency with the project setup.

Coding Guidelines

  • Follow the idiomatic practices of the Go programming language.
  • Write clean, maintainable, and efficient code.
  • Add comments to your code where necessary to explain complex logic.
  • Ensure existing tests pass, and add new tests for every new feature or bug fix.

Pull Request Process

  1. Ensure your code follows the coding guidelines and includes relevant tests.
  2. Update the README.md or other documentation with details of changes to the interface or functionality.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. Your pull request will be reviewed by the maintainers, who may request changes or further clarification.

Reporting Bugs and Suggesting Enhancements

When reporting bugs or suggesting enhancements:

  • Use a clear and descriptive title.
  • Provide a step-by-step description of how to reproduce the problem.
  • Explain the behavior you expected and what occurred instead.
  • Include screenshots or animated GIFs if they help illustrate the issue.

Questions or Concerns?

If you have any questions or concerns, feel free to open an issue or reach out to the maintainers.

Thank you for contributing to the Go client for Sanity!