Skip to content

Commit

Permalink
Merge pull request #2109 from Shopify/amomchilov-patch-1
Browse files Browse the repository at this point in the history
Clarify DSL compiler contribution instructions
  • Loading branch information
amomchilov authored Dec 4, 2024
2 parents d66ad90 + afb33b4 commit 1705eb0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -999,7 +999,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif
### DSL compilers
Contributions to existing DSL compilers are welcome. However, new compilers that support DSLs for gems other than Rails should live outside of Tapioca. Please refer to [writing custom dsl compilers](https://github.com/Shopify/tapioca?tab=readme-ov-file#writing-custom-dsl-compilers) for more information.
Tapioca ships with a small collection of high quality DSL compilers for popular Ruby gems that are used heavily at Shopify, like Rails and GraphQL. We encourage the community to contribute new DSL compilers, though they shouldn't necessarily live in the Tapioca repo itself.
It's best for DSL compilers to be contributed directly to gems they apply to ([example](https://github.com/Shopify/measured/tree/main/lib/tapioca/dsl/compilers)). This way, when changes are made to the gem's DSL, the gem's DSL compiler can be updated at the same time and be versioned/released together.
If an upstream gem's maintainers don't wish to host a DSL compiler themselves, you can propose contributing it to:
1. Tapioca, if it's a gem that Shopify uses (ask us in an issue or PR)
2. A third party DSL compiler repository, like [AngelList/Boba](https://github.com/angellist/boba). These are not supported by Shopify.
For help writing a DSL compiler, please refer to [writing custom dsl compilers](https://github.com/Shopify/tapioca?tab=readme-ov-file#writing-custom-dsl-compilers).
## License
Expand Down

0 comments on commit 1705eb0

Please sign in to comment.