The Solana Cookbook is meant to house small digestable code snippets for someone that has no experience with blockchain or Solana to be able to grab and go.
The Cookbook is welcome to any and all contributions. Please refer to the project's style when contributing new snippets of code.
Currently we have "topics" under /docs
and the code for those topics
lives under /code/<topic>
.
Recipes are an overarching topic with a list of references of how to do things under that topic. The general structure is the following:
Code Reference Title
Short Summary
Code Snippet
Ingredients are longer form informational documentation on various topics. The general structure for writing an ingredient is the following:
Brief Summary/TLDR
Fact Sheet
Deep Dive
Other Resources
We are using conventional commits for this repository.
To choose a task or make your own, do the following:
- Add an issue for the task and assign to yourself or comment on the issue
- Make a draft PR referencing the issue.
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!
You can find tasks on the project board or create an issue and assign it to yourself.
Happy Cooking!