Contributing Workflow
Anyone in the community is welcome to contribute to the Permaweb Cookbook, as community members we want a high quality reference guide of little snack bite sized nuggets of information. Below is a step by step workflow of how anyone can contribute to this project.
What do you need to know?
- Git and Github - publishes content to github.com.
- Markdown - Markdown is a text based markup language that can be transformed into HTML
- Arweave and the Permaweb - Have some knowledge about the Permaweb that should be shared
Steps to Contribute
Need Help?
Join our discord channel and post a note.
Commiting work
We are using conventional commits for this repository.
General flow for making a contribution:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
Style
Here are some suggestions on tone and style from some contributors:
TIP
In writing them, I'm getting a feeling for the tone that's appropriate for each. CoreConcepts should be rather textbook like, neutral voice, objective. "This is how Arweave works" For Guides, I think it's ok to have a more personal voice. Refer to the reader as "you" and speak in the collaborative voice "next we'll take a look at..." This may just be personal preference, but in general I feel this tone much more supportive and accessible when following a longer form guide. Indeed, its the voice that most popular tutorials from other ecosystems are written in. For Resources, I think it shares the same voice as core concepts, with a preference for brevity.
dmac
TIP
Conceptual and referencial data should have a more cold scientific tone and guides should be a supportive or even humorous tone. Longer form content needs to pull readers in without them zoning out.
Arch_Druid