Skip to content

Latest commit

 

History

History
120 lines (69 loc) · 7.34 KB

CONTRIBUTING.md

File metadata and controls

120 lines (69 loc) · 7.34 KB
Raw
Read these guidelines in other languages

Contribution Guidelines

Hello. 👋

freeCodeCamp.org is possible, thanks to thousands of kind volunteers like you. We are grateful for your contributions and are excited to welcome you aboard.

We strictly enforce our "Code of Conduct". Please take a moment to read it. It's only 196 words long.

Happy contributing.

Here are some fun ways that you can help

You can contribute to any of these:

  1. Contribute to this open-source codebase. Help us edit coding challenges, or fix bugs on the learning platform.

  2. Help campers on our public forum. Answer their coding questions or give them feedback on their coding projects.

  3. Help us add subtitles (closed captions) to our YouTube channel videos.

Contribute to this open-source codebase

Our codebase has thousands of coding challenges and other source code that power our learning platform.

Create, update and fix bugs in our coding challenges

All our coding challenges are curated by the community, bringing in expert knowledge from volunteers like you.

You can help expand them and make their wording better. You can also update the user stories to explain the concept better or remove redundant ones and improve the challenge tests to make them more accurately test people's code.

If you're interested in improving these coding challenges, here's how to work on coding challenges.

Help us fix bugs in freeCodeCamp.org's learning platform

Our learning platform runs on a modern JavaScript stack. It has various components, tools, and libraries, including but not limited to, Node.js, MongoDB, LoopBack, OAuth 2.0, React, Gatsby, Webpack, and more.

Broadly,

  • We have a Node.js based API server.
  • A set of React-based client applications.
  • A script that we use to evaluate our front-end projects.

Contributing to this requires some understanding of APIs, ES6 Syntax, and a lot of curiosity.

Essentially, we expect basic familiarity with some of the aforementioned technologies, tools, and libraries. With that being said, you are not required to be an expert on them to contribute.

If you want to help us improve our codebase, you can either set up freeCodeCamp locally or use Gitpod, a free online dev environment.

Open in Gitpod

(Starts a ready-to-code dev environment for freecodecamp in your browser.)

Frequently Asked Questions

How can I report a bug that is not on board?

If you think you've found a bug, first read the "Help I've Found a Bug" article and follow its instructions.

If you're confident it's a new bug, go ahead and create a new GitHub issue. Be sure to include as much information as possible so that we can reproduce the bug. We have a pre-defined issue template to help you through this.

Please note that any issues that seek coding help on a challenge will be closed. The issue tracker is strictly for codebase related issues and discussions. Whenever in doubt, you should seek assistance on the forum before making a report.

How can I report a security issue?

Please don't create GitHub issues for security issues. Instead, please send an email to security@freecodecamp.org and we'll look into it immediately.

What do these different labels that are tagged on issues mean?

Our community moderators triage issues and pull requests based on their priority, severity, and other factors. You can find a complete glossary of their meanings here.

You should go through help wanted or first timers welcome issues for a quick overview of what is available for you to work on.

These are up for grabs, and you do not need to seek permission before working on them. If these issues lack clarity on what needs to be done, feel free to ask questions in the comments.

I found a typo, should I report an issue before I can make a pull request?

For typos and other wording changes, you can directly open pull requests without first creating an issue. Issues are more for discussing larger problems associated with code or structural aspects of the curriculum.

How do I get an issue assigned to me?

We typically do not assign issues to anyone other than long-time contributors to avoid ambiguous no-shows. Instead, we follow the below policy to be fair to everyone:

  1. The first pull-request for any issue is preferred to be merged.
  2. In the case of multiple pull-requests for the same issue, we give priority to the quality of the code in the pull-requests.
    • Did you include tests?
    • Did you catch all use-cases?
    • Did you ensure all tests pass, and you confirmed everything works locally?
  3. Finally, we favor pull-requests which follow our recommended guidelines.
    • Did you follow the pull-request checklist?
    • Did you name your pull-request title meaningfully?

You do not need any permission for issues that are marked help wanted or first timers welcome as explained earlier. Follow the guidelines carefully and open a pull-request.

I am new to GitHub and Open Source, where should I start?

Read our How to Contribute to Open Source Guide.

I am stuck on something that is not included in this documentation. How can I get help?

Feel free to ask for help in:

We are excited to help you contribute to any of the topics that you would like to work on. Feel free to ask us questions on the related issue threads, and we will be glad to clarify. Make sure you search for your query before posting a new one. Be polite and patient. Our community of volunteers and moderators are always around to guide you through your queries.

When in doubt, you can reach out to our platform dev team to help you with this:

Name GitHub Twitter
Mrugesh Mohapatra @raisedadead @raisedadead
Ahmad Abdolsaheb @ahmadabdolsaheb @Abdolsaheb
Kristofer Koishigawa @scissorsneedfoodtoo @kriskoishigawa

Email: dev@freecodecamp.org