From b82f03437ac6313e1fdffe36513b0a87f2ca878c Mon Sep 17 00:00:00 2001 From: Quincy Larson Date: Thu, 11 Oct 2018 21:54:43 -0500 Subject: [PATCH] Improve contributing.md wording --- CONTRIBUTING.md | 65 +++++++++++++++++++------------------------------ 1 file changed, 25 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eaf1e033642..b11817fef7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,40 +15,35 @@ Hello 👋! -freeCodeCamp.org is possible thanks to thousands of kind volunteers like you. We are grateful for your contributions, and we are excited to welcome you onboard. +freeCodeCamp.org is possible thanks to thousands of kind volunteers like you. We are grateful for your contributions, and we are excited to welcome you aboard. -We strictly enforce our ["Code of Conduct"](https://www.freecodecamp.org/code-of-conduct). Take a moment to read it. It's not very long. +We strictly enforce our ["Code of Conduct"](https://www.freecodecamp.org/code-of-conduct). Take a moment to read it. It's only 196 words long. -Happy Contributing 🎉! +Happy contributing 🎉! ## Here are some fun ways you can help -You can choose to contribute to an area of you interest: +You can choose to contribute to any area that interests you: -1. [Contribute to this open source codebase.](#contribute-to-this-open-source-codebase) +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. - Help us in creating or editing [guide articles](https://www.freecodecamp.org/guide), [coding challenges](https://www.freecodecamp.org/learn) and fixing 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) -2. Help campers on our [public forum](https://www.freecodecamp.org/forum/). - - - ❓ Help campers by [answering their questions](https://www.freecodecamp.org/forum/?max_posts=1). - - 💬 [Give feedback](https://www.freecodecamp.org/forum/c/project-feedback?max_posts=1) on camper projects. - -3. Help us add subtitles on our [YouTube channel](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ/videos). +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://www.freecodecamp.org/learn) and [Guide articles](https://www.freecodecamp.org/guide). These challenges and articles make up the learning content available on the freeCodeCamp.org's learning platform. +We have a huge open source codebase of the thousands of [coding challenges](https://www.freecodecamp.org/learn) and [guide articles](https://www.freecodecamp.org/guide). You can help us: -- [📝 Research, Write and Update our guide articles.](#research-write-and-update-our-guide-articles) +- [📝 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) +- [💻 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) +- [🌐 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) +- [🛠 Help us fix bugs in freeCodeCamp.org's learning platform](#help-us-fix-bugs-in-freecodecamporgs-learning-platform) ### Research, Write and Update our guide articles @@ -66,35 +61,27 @@ To help, find a `stub article` on our [Guide website](https://www.freecodecamp.o 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. -**If you would like work on these, follow along these guidelines:** - -#### [How to work on Guide articles.](/docs/how-to-work-on-guide-articles.md) +If you would like to help improve guide articles, here's [how to work on guide articles](/docs/how-to-work-on-guide-articles.md). ### 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. -However, these need to be constantly refined, for quality. For example, you may want to update instructions to improve their [verbiage](https://en.oxforddictionaries.com/definition/verbiage). You can update the user stories to explain the concept better and even remove redundant ones. You may want to refactor tests which do not pass with valid code for the user stories. +You can help expand them and make their wording more clear. You can update the user stories to explain the concept better and even remove redundant ones. You can also improve the challenge tests to make them more accurately test people's code. -**If you would like work on these, follow along these guidelines:** - -#### [How to work on Coding Challenges.](/docs/how-to-work-on-coding-challenges.md) +If you're interested in improving these coding chalenges, here's [how to work on coding challenges](/docs/how-to-work-on-coding-challenges.md). ### 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: -- Chinese (中文) -- Russian (русский) -- Arabic (عربى) -- Spanish (Español) -- Portuguese (Português) +- [Chinese (中文)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/chinese) +- [Russian (русский)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/russian) +- [Arabic (عربى)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/arabic) +- [Spanish (Español)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/spanish) +- [Portuguese (Português)](https://github.com/freeCodeCamp/freeCodeCamp/tree/master/curriculum/challenges/portuguese) -Most of these versions are machine translated. We would love your help in improving the quality of these translations. - -**If you would like work on these, follow along these guidelines:** - -**[TODO]** We are in the process of updating docs for the translation workflow. Follow [`#18313`](https://github.com/freeCodeCamp/freeCodeCamp/issues/18313) for the progress. +We would love your help in improving the quality of these translations. Millions of people use the English language version of freeCodeCamp.org, and we expect millions more to use these translated versions as well. ### Help us fix bugs in freeCodeCamp.org's learning platform @@ -112,9 +99,7 @@ Essentially we expect certain basic familiarity, with some of the aforementioned 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. -**If you would like work on these, follow along these guidelines:** - -#### [How to setup freeCodeCamp locally.](/docs/how-to-setup-freecodecamp-locally.md) +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 @@ -134,8 +119,8 @@ Please don't create GitHub issues for security issues. Instead, please send an e Feel free to ask for help in: -- [The "Contributors" category our public forum](https://www.freecodecamp.org/forum/c/contributors). -- [Our public contributors chat room on Gitter](https://gitter.im/FreeCodeCamp/Contributors). +- [The "Contributors" category 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. @@ -153,4 +138,4 @@ If these issues lack clarity on what needs to be done, feel free ask questions i **I found a typo, should I report an issue before I can make a pull request?** -You can straight away create a pull request without having to report any issues, for typos, or small changes to [verbiage](https://en.oxforddictionaries.com/definition/verbiage). Issues are a tool to seek confirmation on changes that you would want to propose via a pull request. +For typos and other wording changes, you can directly open pull requests without first creating an issues. Issues are more for discussing larger problems associated with code, or more structural aspects of the curriculum.