# Documentation fixes as a starting point for open-source contributions

DevFeed: [Documentation fixes as a starting point for open-source contributions](<https://devfeed.tech/articles/the-easiest-way-to-get-into-open-source-26276.md>)

Original publisher: [Read original article](<https://www.justinweiss.com/articles/the-easiest-way-to-get-into-open-source/>)

Author: Justin Weiss

Published: 2015-07-08T03:23:04Z

Content type: tutorial

Language: en

Sources: [Justin Weiss](<https://devfeed.tech/sources/justin-weiss.md>)

Topics: [Open Source](<https://devfeed.tech/topics/open-source.md>), [Documentation](<https://devfeed.tech/topics/documentation.md>), [Pull Request](<https://devfeed.tech/topics/pull-request.md>), [GitHub](<https://devfeed.tech/topics/github.md>), [Rails](<https://devfeed.tech/topics/rails.md>), [Elixir](<https://devfeed.tech/topics/elixir.md>)

Tags: [contribute](<https://devfeed.tech/tags/contribute.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [github](<https://devfeed.tech/tags/github.md>), [open-source](<https://devfeed.tech/tags/open-source.md>), [pull-request](<https://devfeed.tech/tags/pull-request.md>)

## AI overview

The article recommends documentation fixes as an accessible way to begin contributing to open-source projects. It explains that doc changes can often be made without setting up the project, are easier to revise during pull-request review, and help maintainers address unclear documentation.

## Source excerpt

This article is also available in Korean, thanks to Dohyung Ahn! Thom Parkin made a great point in the comments of an earlier article of mine: Great advice. But you missed one very important [final] point. Since this is Open Source, once you have figured out the details of that feature/function where the documentation is a bit light, YOU SHOULD UPDATE THE DOCS AND SUBMIT A PULL REQUEST. In that way the entire community benefits, and you can even gain some "coder cred" for your participation! I'm happy Thom mentioned this, because it's so important. Fixing documentation is the easiest way to start contributing back to the projects you use and love. My first contributions to projects like Rails, Rubinius, and Elixir have all been doc fixes. I've made small tweaks to make things clearer, explained some things that you could only discover by reading the code, even just fixed broken formatting. These have all been quick, easy ways to help out some big open source projects. Even when they're my only contributions to a project, they've still helped future users, and Future Me. And that's what open source is all about. Why documentation fixes are such a great way to get started Doc fixes are the least intimidating way to contribute to a big project like Rails: You don't have to set up the project in order to fix the bug. Since you're just updating the documentation, you don't have to get the tests or the app running. Sometimes, you won't even have to clone the project to your machine - you can make your change right on GitHub! If the maintainer asks you to make changes to your pull request, they're usually a matter of wording or taste. Those kind of changes can be easier to stomach than criticism of your code. And it's easier for you to make those changes, because you don't have to update tests or code, just words. Documentation is hard for a project maintainer, so updates are appreciated. Often, authors are too close to the code to understand where the confusing parts are.