Docs Contribution Guide Overview

Welcome to the Docs Contribution Guide! Docs is an open contribution reference for all things code and code-related, and it relies on contributions from creative folks like you. This guide will help you learn all the things you need to know to contribute your own content to the Docs project. The guide is broken up into sections that review each part of the contribution process, from selecting an issue to work on, setting up your PC to work with the Docs GitHub repo, to writing your entry, to creating a pull request and implementing feedback from the Docs’ maintainers. We also have a FAQ that goes over the most common questions and issues the Docs community has had when contributing to Docs. Good luck, and we look forward to seeing your contributions!

Get started with these steps

  1. 1

    Claiming an issue

    Browse available Issues on GitHub and select one(s) to work on.

  2. 2

    Getting set up on your computer

    Create a local copy of the Docs repository (repo) by forking the main remote repo and cloning it onto your computer. Then, create a separate feature branch in the forked repo. In the feature branch, create a markdown file for your entry or edit existing entries depending on the Issue description.

  3. 3

    Writing your doc

    Plan your write-up for new entries or edits with the available templates on GitHub for topic, concept, or term entries. Then, to your best ability, self-revise your entry as needed to match the Docs style and format.

  4. 4

    Creating a pull request and revisions

    Commit changes on your feature branch with a meaningful message and push up to the forked remote repo. Then, create a pull request (PR) on GitHub. Maintainers will review your changes, request for improvements, and continue this process until the PR meets technical and formatting standards.

Frequently asked questions

  • There are several benefits to contributing to Docs. Contributing to documentation is a great way to build out a portfolio of technical content that you can show to potential employers. By adding to documentation on Codecademy, you will be helping other learners get support on their journey while helping yourself develop mastery over the content you are studying. Finally, frequent Docs contributors become eligible to join the Code Crew, Codecademy’s super user program, whose benefits include Free Pro Access, networking opportunities, and several other exciting benefits. Go to our Contribute to Docs page to learn more about the benefits of getting involved.

Top Community Contributors

Learn Open Source on Codecademy