Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1.96 KB
Raw

Contributing to GOAT

Thank you for considering contributing to GOAT! We welcome all contributions that help improve the project and enhance its functionality. Before contributing, please take a moment to review these guidelines and ensure that your contributions align with our expectations and requirements.

How to Contribute

Here are the general steps for contributing to GOAT

  1. Fork the project repository to your GitHub account.

  2. Clone your forked repository to your local machine.

    git clone git@github.com:[your-username]/[project-name].git

  3. Create a new branch to work on your changes.

    git checkout -b [branch-name]

  4. Make your changes and commit them to your local repository. Be sure to write clear and descriptive commit messages.

  5. Push your changes to your forked repository.

    git push origin [branch-name]

  6. Submit a pull request to the original project repository. Be sure to describe your changes in detail and provide any relevant context or background.:

Guidelines and Requirements

Here are some guidelines and requirements to keep in mind when contributing to GOAT:

  • All code contributions must be accompanied by tests that demonstrate the functionality and expected behavior of the changes.
  • Code contributions should follow the project's established coding style and formatting conventions.
  • All contributions should be submitted as pull requests, and should not be merged directly into the main branch.
  • Contributors should be respectful and professional in their interactions with other members of the community.

Code of Conduct

All contributors to GOAT are expected to follow our Code of Conduct. This document outlines our expectations for respectful behavior and communication within the project community.

Feedback and Support

If you have any questions, comments, or feedback about GOAT please feel free to contact us. We appreciate your contributions and look forward to working with you!