Claiming an issue

Docs is open-contribution which means that we accept content from all learners. Due to the growing Docs community, it’s important to distribute opportunities in a fair manner. One way we do this is through Issues. We’ll go over how issues work on Docs so you can get comfortable with our workflow.

Reviewing the issues log

A first step in contributing to Docs is to find an issue that you’d like to work on. You can explore currently available issues by navigating to the docs repository and clicking on the Issues tab.

screenshot of Docs GitHub repository with the Issues tab outlined

Once on the issues page you can review the current, or outstanding issues, to see if there are any that you would like to take on. Many of the issues will already be claimed, meaning that there is already a contributor working on the issue. In order to see which ones are unclaimed you can scan the list and look to see if there is a contributor featured in the Assignee column, or look for a ‘claimed’ label. Another method is to select the Labels drop-down menu and option-click ‘claimed’, which will filter the results to only show issues that are currently unassigned.

screenshot of Docs GitHub repository Issues page with Assignee dropdown menu open and 'Assigned to nobody filter' option outlined

screenshot of Docs GitHub repository Issues page with Label dropdown menu open and 'claimed' label outlined

Additionally, you can filter the open issues by another label to further narrow down the possibilities and find something that may better suit your interests or experience level (such as selecting ‘good first issue’ or selecting a particular language ‘javascript’).

Keeping tabs on new issues

There are new issues added every week, so, if you can’t find anything you’d like to work on be sure to check back at a later date. It is also possible to receive notifications when there are updates to the issues log. If you’d like to be notified, select the Watch button at the top, right-hand side of the page, select Custom from the drop-down options, and then select the checkbox next to Issues.

screenshot of Docs GitHub repository Issues page with Watch dropdown menu open and Custom Notifications option with Issues checkbox selected

Submitting a new issue

It is also possible to submit a new issue. If you have noted an error such as a typo or broken link, feel free to create a new issue for that correction. You can submit a new issue by clicking the New Issue button on the right-hand side of the page, selecting the applicable template and filling out the associated form.

Another source for new issues are topic areas or elements not currently addressed by Docs. If you are aware of concepts or technologies that have yet to be addressed that you believe would be a good addition to Docs please go to the Docs Forums page and reply to the Possible Content Discussion or create a New Discussion on our discussions page, so that it can be addressed and evaluated by Docs maintainers.

Making a request

Finally, if you find an issue you’d like to work on, click on the issue and leave a comment in order to communicate your interest. Please tag a docs maintainer in your comment. A maintainer will generally respond to your comment within 3 days.

Contributor community

Connect with other contributors and get answers to your questions in Forums.

Learn Open Source on Codecademy

On this page