From bba728a0b63f9775bff69cc3193f76974f967655 Mon Sep 17 00:00:00 2001 From: developomp Date: Tue, 22 Jun 2021 17:05:32 +0900 Subject: [PATCH] fixed grammatical errors and resolved ambiguity --- CONTRIBUTING.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 125dac7..a32961e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,20 +8,18 @@ tl;dr for dummies: - contribution is only for developers - code contributions only. No article contribution. -This document is aimed for developers. Basic level of development knowledge is expected from contributors. -To be specific, contributors are expected to be familiar with the javascript language, react framework, and code analyzers and formatters. -If you are **not** a developer, but have suggestions and/or bug report, feel free to go to [GitHub issues page](https://github.com/developomp/developomp-site/issues). - -though the code is written with multi author in mind, I won't take article contributions. +This document is aimed for developers. Basic level of development knowledge is expected from the contributors. +To be specific, contributors are expected to be familiar with the javascript language, react framework, code analyzers, and formatters. +If you are **not** a developer, but have suggestions and/or bugs you wish to report, feel free to do so in the [GitHub issues page](https://github.com/developomp/developomp-site/issues). ## Guidelines -- Usage of vscode is highly recommended but other IDE works too as long as the code style is consistent. +- Usage of vscode is highly recommended. Other IDE are allowed as long as the code style is consistent. - All contributions must be made in form of a github pull request. Sending code through email or other platform is not welcomed. -- Format code using Prettier formatter with [this](./.prettierrc) configuration. -- test your code before making pull request. +- Format code using the [prettier](https://prettier.io) formatter with [this](./.prettierrc) configuration. +- Test your code before making a pull request. - Make sure to write basic comments to help other people understand your code at first glance. -- file top comment +- Add a comment in the following format for each code file. ```javascript /** filename.tsx