How to read a project before you contribute

Every project is different. Before you change anything, spend time reading. These files tell you how the project expects to be worked on, and reading them first saves you and the maintainer time.

Files to read first

• README: what the project does and how to install and run it.
• CONTRIBUTING: how to propose changes, which branch to use, how to name commits, and how to run tests.
• CODE_OF_CONDUCT: how people are expected to treat each other, and how to report a problem.
• LICENSE: the terms under which the code can be used. Your contribution is shared under the same terms.

Run the project and its tests

Follow the README to install dependencies and start the project. Then run the tests before you change anything, so you know what passing looks like. If a step fails, write down exactly what you ran and the first error you saw; that is the most useful thing to share when you ask for help.

Read the open issues

Open issues show what the project needs and how people talk to each other. Look for labels such as good first issue, and read the discussion before you start. In a Devprentice program, your first Milestone names the work, so you can read its issue and related code in advance.

When you are stuck

Being stuck is normal. Try for a reasonable time, then ask through the program's help route. Say what you were trying to do, what you ran, what happened, and what you already tried.