Document your design and build
Journaling is one of the most important parts of submitting a project for Rework. Instead of using Hackatime or Lapse, Rework uses a journaling system similar to Highway and Blueprint. If you have participated in either of those programs, please read this anyway as there are a couple differences!
A journal is a markdown file (named JOURNAL.md) that you use to document your work in creating your projects.
Journaling is mandatory and a great opportunity for you to be able to share your work with the world!
People want to see progress, not just completed work. You should include struggles, successes, wins, and losses,
it all adds to your project. Projects with low quality journaling will be rejected!
A journal is broken down into multiple entries, one from each of your sessions working on the project, all of which must include the following:
A template for a journal entry could look like this:
# February 1 10:11pm : Added fan mounts
[actual journal content - what did you do?]
[pictures of what you worked on]
**Total time spent: 2h**Every journal entry you do needs to meet all of these requirements!
Your journal should be:
Your journal should be readable by others and sound like your voice. This means that we have a strict no AI in journals rule. If you used AI in your journal the project will be rejected and you will be asked to rewrite it in your own words.
Your journal should be something that others would be interested in reading! Share your process, your thoughts, and what you learned along the way.
Create your JOURNAL.md and start documenting your build!
View Submission Guidelines