Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved flow and grammar #19970

Merged
merged 2 commits into from Oct 23, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 20 additions & 20 deletions CONTRIBUTING.md
Expand Up @@ -21,43 +21,43 @@ We strictly enforce our ["Code of Conduct"](https://www.freecodecamp.org/code-of

Happy contributing 🎉!

## Here are some fun ways you can help
## Here are some fun ways that you can help

You can choose to contribute to any area that interests you:

1. [Contribute to this open source codebase](#contribute-to-this-open-source-codebase). Help editing [guide articles](https://guide.freecodecamp.org/), [coding challenges](https://learn.freecodecamp.org/), or fix bugs on the learning platform.
1. [Contribute to this open source codebase](#contribute-to-this-open-source-codebase). Help to edit [guide articles](https://guide.freecodecamp.org/), [coding challenges](https://learn.freecodecamp.org/), or fix bugs on the learning platform.

2. Help campers on our [public forum](https://www.freecodecamp.org/forum/). [Answer their coding questions](https://www.freecodecamp.org/forum/?max_posts=1) or [give them feedback on their coding projects](https://www.freecodecamp.org/forum/c/project-feedback?max_posts=1)

3. Help us add subtitles to our [YouTube channel videos](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos).

## Contribute to this open source codebase

We have a huge open source codebase of the thousands of [coding challenges](https://learn.freecodecamp.org) and [guide articles](https://guide.freecodecamp.org).
We have a huge open source codebase consisting of thousands of [coding challenges](https://learn.freecodecamp.org) and [guide articles](https://guide.freecodecamp.org).

You can help us:
You can help us to:

- [📝 Research, Write and Update our guide articles](#research-write-and-update-our-guide-articles)

- [💻 Create, Update and Fix Bugs in our coding challenges](#create-update-and-fix-bugs-in-our-coding-challenges)

- [🌐 Translate guide articles and coding challenges](#translate-guide-articles-and-coding-challenges)

- [🛠 Help us fix bugs in freeCodeCamp.org's learning platform](#help-us-fix-bugs-in-freecodecamporgs-learning-platform)
- [🛠 Fix bugs in freeCodeCamp.org's learning platform](#help-us-fix-bugs-in-freecodecamporgs-learning-platform)

### Research, Write and Update our guide articles

**What are Guide articles?**

Guide articles help you get a quick understanding of a technology concept. These are short, plain-English explanations that you can read before going on to more in-depth resources.
Guide articles help you to get a quick understanding of a technology concept. These are short, plain-English explanations that you can read before going on to more in-depth resources.

You can find an [example article about HTML Anchor Elements here](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/english/html/elements/a-tag/index.md).

**What can I write an article about?**

We welcome your help writing these articles. You don't have to be an expert in a topic to write about it—this entire Guide is open source, so even if you make a mistake, another contributor will eventually correct it.
We welcome your help in writing these articles. You don't have to be an expert in a topic to write about it—this entire Guide is open source, so even if you make a mistake, another contributor will eventually correct it.

To help, find a `stub article` on our [Guide website](https://guide.freecodecamp.org), write the article, then open a pull request to replace the stub with your article. A [pull request](https://help.github.com/articles/about-pull-requests/) is how you'll suggest changes. It lets others know about your changes, review them and adopt them.
To help, find a `stub article` on our [Guide website](https://guide.freecodecamp.org), write the article, then open a pull request to replace the stub with your article. A [pull request](https://help.github.com/articles/about-pull-requests/) is how you'll suggest changes. It lets others know about, review, and eventually adopt your changes.

If you can't find a stub about the topic you'd like to write about, you can open a PR that creates the stub and includes your draft article.

Expand All @@ -73,7 +73,7 @@ If you're interested in improving these coding challenges, here's [how to work o

### Translate guide articles and coding challenges

You can help us translate our Guide articles and Coding challenges for a language that you speak. Currently we have translated versions in:
You can help us to translate our Guide articles and Coding challenges into a language that you speak. Currently we have translated versions in:

- [Chinese (中文)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/chinese)
- [Russian (русский)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/russian)
Expand All @@ -95,47 +95,47 @@ Broadly,

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

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

Feel free to ask us questions, on the related issue threads, and we will be glad to clarify. When in doubt, you can reach Mrugesh Mohapatra [`@raisedadead`](https://github.com/raisedadead) or Stuart Taylor [`@bouncey`](https://github.com/bouncey) from our platform dev team to help you with this.
Feel free to ask us questions on the related issue threads and we will be glad to answer them. When in doubt, you can reach Mrugesh Mohapatra [`@raisedadead`](https://github.com/raisedadead) or Stuart Taylor [`@bouncey`](https://github.com/bouncey) from our platform dev team to help you with this.

If you want to help us improve our codebase, here's [how to setup freeCodeCamp locally](/docs/how-to-setup-freecodecamp-locally.md).

## Frequently Asked Questions

**How can I report a bug, that is not on board?**
**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"](https://forum.freecodecamp.org/t/how-to-report-a-bug/19543) 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 we can reproduce the bug. We have a pre-defined issue template to help you through this.
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 st thwe 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 the codebase related issues and discussions. You should [seek assistance on the forum](https://www.freecodecamp.org/forum) before reporting whenever in doubt.
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](https://www.freecodecamp.org/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.

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

Feel free to ask for help in:

- [The "Contributors" category our public forum](https://www.freecodecamp.org/forum/c/contributors)
- [The "Contributors" category of our public forum](https://www.freecodecamp.org/forum/c/contributors)
- [Our public contributors chat room on Gitter](https://gitter.im/FreeCodeCamp/Contributors)

We are excited to help you contribute to any of the topics that you would like to work on. Make sure you search for your query before posting a new one. Be polite and patient. Our community volunteers and moderators are always around to guide you through your queries.
We are excited to help you contribute to any of the topics that you would like to work on. 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.

**I am new to GitHub and Open Source in general:**

Read our [How to Contribute to Open Source Guide](https://github.com/freeCodeCamp/how-to-contribute-to-open-source).

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

Our community moderators [triage](https://en.wikipedia.org/wiki/Software_bug#Bug_management) issues and pull requests based on their priority, severity and other factors. You can [find a complete glossary of their meanings here](https://github.com/freecodecamp/freecodecamp/labels).

You should go through **`Help Wanted`** or **`first timers welcome`** issues for quick lookup of what is available for you to work on. These are up for grabs and you do not need a go ahead before working on these.
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 more structural aspects of the curriculum.
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.