Skip to content

Contributing to Loom

Thank you for considering contributing to Loom! We welcome contributions from everyone.

Getting Started

  1. Fork the Repository: Click the 'Fork' button at the top right of this page.
  2. Clone Your Fork: Clone your fork to your local machine using git clone https://github.com/yourusername/loom.git.
  3. Create a Branch: Create a new branch for your changes using git checkout -b feature/your-feature-name.
  4. Make Changes: Make your changes to the codebase.
  5. Commit Changes: Commit your changes with a descriptive message using git commit -am 'Add your feature'.
  6. Push Changes: Push your changes to your fork using git push origin feature/your-feature-name.
  7. Open a Pull Request: Go to the original repository and click 'New Pull Request'. Select your branch as the 'compare' branch and fill out the pull request template.

Code Style

Please follow the existing code style guidelines. We use Go fmt for formatting Go code.

Testing

Before submitting a pull request, please ensure that all tests pass. You can run the tests using go test ./....

Reporting Issues

If you encounter any issues, please report them by opening an issue in the issues section. Provide as much detail as possible to help us understand and resolve the issue.

License

By contributing to Loom, you agree that your contributions will be licensed under the MIT License.