Contributing to Restyled
Restyled is built in the open and community contributions are very much encouraged.
When you open your first Pull Request, https://cla-assistant.io/ will post a red status and ask you to sign our CLA.
This is the source behind https://restyled.io. These are the frontend pagers users interact with, as well as an API used by agents to interact with any stateful data. Its /webhooks endpoint is effectively a proxy for enqueuing Jobs that agents then pick up.
This process runs on each of our "Restyle Machine" instances. It picks Jobs off of the queue and processes them by invoking the restyler CLI. It's primary responsibility is coordinate this loop and interact with our API to check plan restrictions and record Job states.
This is the complete process of restyling a single Pull Request encapsulated as a CLI and shipped in a Docker image. This is where to go if you want to change how Pull Request status updates happen, how errors are handled, how the comments look, etc.
Documentation for the restyler codebase can be found here. It may or may not be useful, it may or may not be up to date.
This is a collection of Dockerfiles and support files that define all our Restylers. This is where you want to go to add or fix an individual restyler. To work in here, you will likely need our SDK. See https://github.com/restyled-io/restyled.io/wiki/Adding-a-Restyler.
- Open an Issue on the repository in question,
- Join our Zulip Chat (beware: it's typically very quiet), or
- Email Support