Skip to main content

🌱 How to Complete your Tutorial

Step-by-step instructions to complete your Celo Sage tutorial.


Getting Started​

After submitting your tutorial, it will be reviewed by a team member from the Celo Foundation. After review your tutorial submission will either be accepted, rejected, or you will receive feedback on how to improve the idea.

  • Accepted: Move forward with instructions below on how to complete your tutorial.
  • Rejected: This idea does not meet the legel standards or best practices for a Celo Sage tutorial.
  • Improve: The idea may need some additional support before getting started. Please address the feedback you receive and work with the team until your idea is Accepted.
tip

Check out the Contribution Guidelines and Tutorial Structure for best practices while completing your tutorial.

Tutorial Creation Process​

  • Move the Trello Card for your tutorial from Todo to In progress
  • Follow the link in the Trello card to access the Google Doc where you’ll write your tutorial content
  • Once you have completed your tutorial, move your Trello Card from In progress to Review and please wait as we review your tutorial and address any comments from your reviewer.
  • Once approved, we will move your Trello Card into the Approved column. From here you can convert your tutorial to markdown and submit a PR to the docs repo.
tip

After your PR is approved, please follow the instructions detailed in the email titled Celo Sage Payments and KYC to ensure you receive payment for your contribution.

How to Create a PR​

  • Fork the https://github.com/celo-org/docs repo.
  • Create a branch name with syntax - sage/<tutorial-title>
  • Create a PR from your branch to main branch. Make sure to add ?template=celo-sage-template at the end of the PR URL to get the template for the PR.

Example - <https://github.com/celo-org/docs/compare/main>...<branchname>?template=celo-sage-template

tip

If you have issue getting the PR Template, you can get the template from here - Celo Sage PR Template.