Stream: contributing

Topic: Help Wanted: Example Ideas

Luke Boswell (Mar 13 2023 at 06:06):

I'm helping Anton with the new roc-lang/examples repository, and it would be really helpful to get some feedback from the community with ideas. The goal is to populate the repo with meaningful content so that it provides value to the community, and also tests Roc design assumptions.

It would be really helpful if you can think of one or more ideas and drop them in a comment below. Bonus points if you can make a working example and share a gist too. :wink:

The Examples repository should provide working code that solves a specific need for a user. It should be as easy as navigating to a relevant example, copying it into a file, and now you have working code!

The aim is to support a variety of needs such as; application templates, content for guides and tutorials, and helpful scripts etc.

Other thoughts;

• Try to describe what the example does, and why would you use it?
• It should be something that you would personally copy or share with someone
• The platform and any packages are URLs, not relative links, so it just works™

Here are some examples of examples that I can think of to seed your creativity;

• WHAT: Hello-World or similar minimal app. WHY: use it for teaching, so I can link to it from a tutorial or guide and share with people who are new to the language, or new to programming.
• WHAT: Lists the files and folders in a directory. WHY: use it as a template for when I want to take a directory as an argument, or process multiple files such as parsing data.
• WHAT: Run roc check, roc test, and then roc build --bundle on a specific Roc package. WHY: a script I would like to use in a CI action to bundle and share a package.

Anton (Mar 13 2023 at 11:31):

I think cookbooks like these can also provide a lot of inspiration:
https://www.oreilly.com/library/view/python-cookbook-3rd/9781449357337/
http://scalacookbook.com/

Last updated: Jul 06 2025 at 12:14 UTC