> For the complete documentation index, see [llms.txt](https://jho406.gitbook.io/breezy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jho406.gitbook.io/breezy/contributing.md).

# Contributing Guide

## Code of Conduct

We welcome pull requests from everyone. By participating in this project, you\
agree to abide by the thoughtbot [code of conduct](https://thoughtbot.com/open-source-code-of-conduct).

We expect everyone to follow the code of conduct anywhere in thoughtbot's\
project codebases, issue trackers, chat-rooms, and mailing lists.

### Opening a PR

1. Fork the repo,
2. Navigate to the `superglue` directory,
3. Run `npm install` to install the base dependencies,
4. Run the test suite: `npm run test`,
5. Make your changes,
6. Push your fork and open a pull request.

A good PR will solve the smallest problem it possibly can and have good test\
coverage.