Skip to content

Commit 181fde2

Browse files
authored
Use reviewdog to automate reviews (#291)
1 parent bbb7865 commit 181fde2

File tree

11 files changed

+39
-73
lines changed

11 files changed

+39
-73
lines changed

.github/workflows/lint.yml

Lines changed: 0 additions & 62 deletions
This file was deleted.

.github/workflows/reviewdog.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: reviewdog
2+
on: [pull_request]
3+
jobs:
4+
misspell:
5+
name: runner / misspell
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v1
9+
- uses: reviewdog/action-misspell@v1
10+
with:
11+
github_token: ${{ secrets.GITHUB_TOKEN }}
12+
reporter: github-pr-review
13+
locale: "US"
14+
# Check all files
15+
filter_mode: nofilter
16+
17+
languagetool:
18+
name: runner / languagetool
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v2
22+
- uses: reviewdog/action-languagetool@v1
23+
with:
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
reporter: github-pr-review
26+
level: warning
27+
language: en-US
28+
patterns: "**/*.md **/*.mdx **/*.txt glossary.yml"

content/concepts/clans-allies-and-followers/followers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ kind: concept
55

66
import ThemedImage from "@theme/ThemedImage";
77

8-
You can follow any warrior, be it a friend, a colleague, your students, or just anyone you'd like to track their Codewars carreer. Following someone opens for you a couple of new possibilities.
8+
You can follow any warrior, be it a friend, a colleague, your students, or just anyone you'd like to track their Codewars career. Following someone opens for you a couple of new possibilities.
99

1010
## How to follow someone?
1111

content/concepts/kata/translations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The description is shared among all languages so changing it in your translation
4242

4343
The translation does not have to be finished in one go. It can be saved and kept in draft state as long as necessary. When the translator considers it ready, it can be published which places it in a "pending" state and becomes available for other users to review, approve, edit or reject. Only one translation may be published for any given kata and language. For example, if a published Java translation already exists then a new one may be created but not published until the former is rejected.
4444

45-
After a translation is published, the translator is advised to post a comment in the kata discourse with a link to their translation fork labelled as **Suggestion**. This will notify other users about the fact and it will be easier for others to find such pending translations.
45+
After a translation is published, the translator is advised to post a comment in the kata discourse with a link to their translation fork labeled as **Suggestion**. This will notify other users about the fact, and it will be easier for others to find such pending translations.
4646

4747
**NOTE:** kata authors and users with appropriate privileges are able to add new translations directly within the kata editor. This approach is strongly discouraged for the following reasons:
4848

content/curating/kata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ After a kata gets [retired][approval-criteria], it's removed from a pool of beta
6969
## Maintenance
7070

7171
When some problem with a kata is identified, it should be reported as an Issue or Suggestion, so it could be tracked and eventually fixed.
72-
Some kata, especially ones created a long time ago, can have some issues or suggestions which are still pending, but have been already fixed or are not applicable anymore because the kata has changed. It's very helpful when such old issues are reviewed and marked as resolved if they are not valid anymore. It can also happen that there are posts in the kata discourse which report some problem, but are not labelled appropriately. It's generally a good idea to re-raise such issues as new posts with the correct label, as it should help other users to find them and eventually fix them.
72+
Some kata, especially ones created a long time ago, can have some issues or suggestions which are still pending, but have been already fixed or are not applicable anymore because the kata has changed. It's very helpful when such old issues are reviewed and marked as resolved if they are not valid anymore. It can also happen that there are posts in the kata discourse which report some problem, but are not labeled appropriately. It's generally a good idea to re-raise such issues as new posts with the correct label, as it should help other users to find them and eventually fix them.
7373
Sufficiently privileged users are encouraged to fix any reported problems and improve the quality of affected kata whenever possible.
7474

7575
<!--

content/curating/translation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Unfortunately, there is currently no reliable way to prevent approval of transla
99
When a translation is published, it's put into a pending state and awaits for review and approval. Users who earned related [privileges][privileges-reference] can search for them, review them, and approve or reject them.
1010
Currently, pending translations can be found in one of the following ways:
1111

12-
- Reading through the kata discourse and searching for posts where translators announced the fact that they published a translation. Translators are encouraged to post a message labelled as **Suggestion** in the kata discourse with a link and information about the language of the translation, so others could find it easily.
12+
- Reading through the kata discourse and searching for posts where translators announced the fact that they published a translation. Translators are encouraged to post a message labeled as **Suggestion** in the kata discourse with a link and information about the language of the translation, so others could find it easily.
1313
- Navigating to `https://www.codewars.com/kata/kata-id/translations` page, which lists all translations in two sections: pending ones at the top, and closed ones (approved and rejected) below.
1414
- A small group of users has been granted the privilege of accessing the page with a list of all pending translations eligible for approval by them. This is the most convenient way of searching for pending translations, but not available to every user at the moment.
1515

@@ -20,7 +20,7 @@ When reviewing a translation, users can perform the following steps:
2020

2121
- **Reading the code and description**.
2222
- **Running the tests** against a couple of solutions, to verify if the test suite gracefully handles some unexpected answers and eventual crashes of the solution. Unfortunately, testing tests of a translation is currently rather cumbersome. One possibility is to fork the translation, replace the "Solution" snippet with your own solution, run tests, and discard the fork afterwards. Another way is to create a new kumite from scratch and copy/paste code snippets from the translation under review to your kumite.
23-
- **Reading the comments** to check if there are any remarks from other reviewers and whether they still hold or were addressed appropriately. Be aware that comments under translations cannot be labelled as an **Issue** or **Suggestion**, so there are no additional markers for the severity of the comment. They also cannot be marked as spoilers, so don't reveal too many details about the solution in your comment, if possible.
23+
- **Reading the comments** to check if there are any remarks from other reviewers and whether they still hold or were addressed appropriately. Be aware that comments under translations cannot be labeled as an **Issue** or **Suggestion**, so there are no additional markers for the severity of the comment. They also cannot be marked as spoilers, so don't reveal too many details about the solution in your comment, if possible.
2424
- **Verifying** if the translation holds to [translation authoring guidelines][translation-authoring-guidelines].
2525

2626
After a review is completed, the reviewer can finalize it with one of the following actions:

content/languages/c/authoring/memory-management-techniques.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ Very often overlooked, but a very good approach to represent 2D arrays is to sto
339339
<summary>Example</summary>
340340
341341
```c
342-
//declaration of solution accepting a two-dimentional array
342+
//declaration of solution accepting a two-dimensional array
343343
void play_game_of_life(size_t world_h, size_t world_w, char world_2d[world_h][world_w]);
344344
345345
size_t world_h = ...;

content/references/markdown.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This is the content of the code block.
5656
````
5757

5858
The opening code fence can be followed by an optional text called the info string. When the info string is a valid language ID, `python` for example, the content is syntax highlighted.
59-
See the language's documentation in [supported languages](/languages/) to find the langauge ID.
59+
See the language's documentation in [supported languages](/languages/) to find the language ID.
6060

6161
````markdown
6262
```python

content/references/ui/kata-trainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The attempt button will submit your solution against the kata test cases. These
2525
This button will run your solution against the sample tests, which are the tests shown directly above.
2626

2727
### Skip Button
28-
If you do not wish to complete the kata, you can skip to the next. A new kata will be choosen for you at random, based off of your active [[training routine|Training Routines]].
28+
If you do not wish to complete the kata, you can skip to the next. A new kata will be chosen for you at random, based off of your active [[training routine|Training Routines]].
2929

3030
### Unlock Solutions
3131
If you wish to give up trying to complete the kata on your own, you can unlock the solutions and view other warrior's fully completed solutions. If you choose to go this route, you will forfeit any honor and rank progression that you could have otherwise have earned for completing the kata.

content/training/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Probably nothing. Go through the following checklist and see which applies to yo
160160
- Mark your post with the **Issue** label only if you are perfectly sure that kata is in some way broken and needs to be edited and fixed. If you have difficulties with solving the kata, raise a **Question**, and not an **Issue**.
161161
- Read [this Codewars wiki page ( TODO )](https://github.com/Codewars/Codewars.com/wiki/Kata-Discourse) for some more details on labels.
162162
- Note that because of this three-label system, the standard of issues is _likely more strict_ on Codewars than on other platforms you might be familiar with. As an example, many GitHub issues would be questions or suggestions by this standard.
163-
- Remember that by posting a comment you're communicating with _real humans_, and by labelling (or not labelling) you're requesting the corresponding level of attention from _real humans_. We understand that you may be utterly frustrated about the fact that the answer should be 1064, not 1074, but it needs to be understood that these guidelines provide crucial information that helps the community help you and/or improve the kata, and will also help yourself understand the problem better.
163+
- Remember that by posting a comment you're communicating with _real humans_, and by labeling (or not labeling) you're requesting the corresponding level of attention from _real humans_. We understand that you may be utterly frustrated about the fact that the answer should be 1064, not 1074, but it needs to be understood that these guidelines provide crucial information that helps the community help you and/or improve the kata, and will also help yourself understand the problem better.
164164

165165
### I am stuck. I tried everything and nothing helped. What now? {#more-help}
166166

0 commit comments

Comments
 (0)