Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.37 KB

Contributing to Garf

Thank you for your interest in contributing to Garf!

Getting Started

To get started, follow these steps:

  1. Fork the Garf repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the necessary dependencies by running pnpm install.
  4. Create a new branch for your contribution with git checkout -b new-branch-name.

Making Contributions

Before making any contributions, please ensure that you have read and understood the CODE_OF_CONDUCT.md file.

Here are some tips to help you make successful contributions to Garf:

  1. Check the project's issues list for open issues that you can help with.
  2. If you are working on a new feature, please create a new issue to discuss it with the community.
  3. Write clear, concise, and well-documented code that follows the established style guide.
  4. Add tests to your contribution to ensure that it functions as intended.
  5. Update any necessary documentation.

Submitting Your Contribution

Once you have completed your contribution, create a pull request to the Garf repository. Your pull request will be reviewed by the project maintainers, and they will provide feedback and guidance on how to improve it.

License

By contributing to Garf, you agree that your contributions will be licensed under the MIT License. See the LICENSE file for details.