If you’re eager to share your knowledge and expertise in developing applications on the zkSync Era, you’ve landed in the right place! This guide walks you through the process of creating and submitting a tutorial to the zkSync community. Let’s get started!

Understanding the Community Tutorials

The zkSync Community Tutorials repository thrives on contributions from talented community members. It’s a space where tutorials are linked and referenced in the zkSync Community Code documentation website, ensuring your work reaches a wider audience. Each tutorial must meet specific requirements and adhere to a structured format to be accepted.

Requirements for your Tutorial

• Showcase how to develop applications on zkSync Era.
• Maintain a neutral stance; avoid promoting specific projects.
• Ensure your tutorial is an original contribution.
• Be the rightful intellectual property owner of your submission.
• Work with relevant external sources, properly referenced.
• Include working code that supports your tutorial.

Guidelines for Structuring Your Tutorial

Your tutorial should follow a systematic structure to make it easy for readers to follow along. Here’s how to lay it out:

• Create a new folder in the tutorials section using kebab-case (e.g., my-awesome-tutorial).
• Inside your folder, create a TUTORIAL.md file that follows this order:
• Title: (Level 1 heading)
• Introduction: (Level 3 heading) Provide an overview of what will be built.
• Prerequisites: (Level 2 heading) List system and technical requirements including specific versions.
• Build time! (Level 2 heading) Step-by-step instructions on how to build.
• Step 1 — Doing the First Thing: (Level 3 heading)
• Step 2 — Doing the Next Thing: (Level 3 heading)
• Step n — Doing the Last Thing: (Level 3 heading)
• Conclusion: (Level 2 heading) Sum up what the tutorial achieves for the reader.
• Add any relevant code in a code folder and images in an images folder. Remember to compress images using squoosh.app.
• Fill in the tutorials.json file with details such as title, description, tags, time taken, author, and slug (folder name).

Submitting Your Tutorial

Ready to share your creation? Follow these steps:

1. Clone the repository to your local machine.
2. Create a new branch dedicated to your tutorial.
3. Add your tutorial according to the guidelines mentioned above.
4. Submit a pull request to the main repository.

Ensuring Quality: Linting, Formatting, and Spell Check

Prior to submission, ensure your content meets the repository’s standards with the following commands:

• Format your code with Prettier: yarn lint:fmt
• Run a spell check: yarn lint:spell
• To add unrecognized words to the spell checker dictionary, edit cspell-zksync.txt.
• Run the general linting checks: yarn lint:mdl

Troubleshooting

If you face any challenges during the submission or formatting process, consider the following troubleshooting steps:

• Check if you have followed all the guidelines carefully.
• Ensure that your tutorial folder and file structure are correct.
• If you’ve compressed images, make sure they are properly imported in your tutorial.
• Double-check your code snippets for any spelling mistakes or syntax errors.
• Reach out to the community for help by submitting queries in forums or chat groups.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion