Skip to content

Commit ca6aad7

Browse files
author
chabros
committed
Fixes for spelling and grammar
1 parent aba8e51 commit ca6aad7

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

content/curation/howtos/fixing.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,62 @@
22
title: How to Fix a Kata
33
---
44

5-
Codewars kata, like any code, may need bug fixing, improvements, or update to match new versions of runtimes or dependencies. That's why content maintenance activities are important and sometimes can require significant amounts of effort.
5+
Codewars kata, like any code, may need bug fixes, improvements, or updates to match new versions of runtimes or dependencies. That's why content maintenance activities are important and sometimes require significant effort.
66

77
## Finding a kata to fix
88

9-
First step to fix a Codewars kata is to determine what kata need fixing in the first place. Codewars platform provides a couple of ways to find challenges which require maintenance:
9+
The first step to fixing a Codewars kata is determining which kata need fixing in the first place. The Codewars platform provides several ways to find challenges that require maintenance:
1010

11-
- On the [kata search page](https://www.codewars.com/kata/my-languages), every entry shows the amount of pending issues (if it has any).
12-
- Posts on the home page [dashboard](https://www.codewars.com/dashboard/discourse/issues) can be filtered to display most recently reported issues,
13-
- Discourse page of every kata can be filtered for posts labeled as `ISSUE`,
14-
- The [kata search page](https://www.codewars.com/kata/) can be used to find challenges which have not been updated to the latest version of their available languages. For example, to find kata with tests which need to be updated to the latest available version of JavaScript, filter for language: Javascript, and manually add the parameter `&outdated=1` to the url (example link to find all [outdated JavaScript kata](https://www.codewars.com/kata/search/javascript?q=&order_by=sort_date%20desc&outdated=1)).
15-
- The [`codewars/content-issues`](https://github.com/codewars/content-issues) Github repository hosts [wiki pages](https://github.com/codewars/content-issues/wiki) with lists of kata which need an update, and [isseue board](https://github.com/codewars/content-issues/issues) with tickets related to maintenance of kata.
11+
- On the [kata search page](https://www.codewars.com/kata/my-languages), every entry shows the number of pending issues (if any).
12+
- Posts on the home page [dashboard](https://www.codewars.com/dashboard/discourse/issues) can be filtered to display the most recently reported issues.
13+
- The discourse page of every kata can be filtered for posts labeled as `ISSUE`.
14+
- The [kata search page](https://www.codewars.com/kata/) can be used to find challenges that have not been updated to the latest version of their available languages. For example, to find kata with tests that need to be updated to the latest available version of JavaScript, filter for language: JavaScript, and manually add the parameter `&outdated=1` to the URL (example link to find all [outdated JavaScript kata](https://www.codewars.com/kata/search/javascript?q=&order_by=sort_date%20desc&outdated=1)).
15+
- The [`codewars/content-issues`](https://github.com/codewars/content-issues) GitHub repository hosts [wiki pages](https://github.com/codewars/content-issues/wiki) with lists of kata that need an update and an [issue board](https://github.com/codewars/content-issues/issues) with tickets related to kata maintenance.
1616

1717
## Creating a fork
1818

19-
New fork can be initiated by opening kata details page, selecting one of available languages, and clicking the `Fork` button at the top right corner. It opens the fork editor, and all editors are filled with the current state of corresponding code snippets in the selected language, and description. This code can be edited and used as a starting point for a fix.
19+
A new fork can be initiated by opening the kata details page, selecting one of the available languages, and clicking the `Fork` button at the top right corner. This opens the fork editor, where all editors are populated with the current state of the corresponding code snippets in the selected language and description. This code can be edited and used as a starting point for a fix.
2020

2121
:::warning Do not fork outdated forks
22-
Fixes should not be applied by starting with a fork of an already approved fork. For example, when an issue is reported with a JavaScript version of a kata, it should be fixed by forking the current state of the kata, and not by forking the original, approved JavaScript translation, or the most recent JavaScript translation. It is possible that the kata had been modified after the translation was published and approved, and forking an old fork can revert changes applied afterwards.
22+
Fixes should not be applied by starting with a fork of an already approved fork. For example, when an issue is reported with a JavaScript version of a kata, it should be fixed by forking the current state of the kata, not by forking the original, approved JavaScript translation or the most recent JavaScript translation. The kata may have been modified after the translation was published and approved, and forking an old fork can revert changes applied afterward.
2323
:::
2424

2525
:::warning Prefer forks to direct edits
26-
Applying fixes by forks is preferred over updates done with the kata editor. Forks can be reviewed and reviewers can share their remarks before approving the fix.
26+
Applying fixes via forks is preferred over updates done with the kata editor. Forks can be reviewed, and reviewers can share their remarks before approving the fix.
2727
:::
2828

2929
### Scope of a fix
3030

31-
A single Codewars challenge can be affected by more than one problem. It can be tempting to fix as many things as possible in one go, or even rewrite tests completely, but it is not always the best approach. Forks with extensive changes require a lot of effort to create, can be difficult to review, and it is more difficult for reviewers to determine what they attempt to fix and find potential bugs. Forks which are difficult to review can stay not reviewed, and not approved, for a long time. A user has to find a good balance between fixes with large amount of changes attempting to fix many things at once, and fixes with small amount of changes, which are easy to review and approve. Applying a series of small fixes can sometimes be easier than applying one fix for many issues at once.
31+
A single Codewars challenge can be affected by multiple problems. It may be tempting to fix as many things as possible in one go or even rewrite tests completely, but this is not always the best approach. Forks with extensive changes require significant effort to create, can be difficult to review, and make it harder for reviewers to determine what they attempt to fix and identify potential bugs. Forks that are difficult to review may remain unreviewed and unapproved for a long time.
3232

33-
It is recommended to write a short post on a published fork with information what problems it addresses.
33+
A user must find a balance between making large-scale fixes that attempt to address many issues at once and smaller, incremental changes that are easier to review and approve. Sometimes, applying a series of small fixes is more effective than attempting to fix multiple issues in a single fork.
34+
35+
It is recommended to write a short post on a published fork explaining what problems it addresses.
3436

3537
### Announcing the fork
3638

37-
When a fork with a fix is ready, it needs to be published for a review, and potentially merged. To notify reviewers about a fork ready for review, it can be helpful to announce the fix with a message posted in the discourse section of the kata (labeled as `SUGGESTION`), and with a message posted to the `#fixing` channel of Codewars Discord.
39+
When a fork with a fix is ready, it needs to be published for review and potential merging. To notify reviewers about a fork ready for review, it can be helpful to announce the fix with a message posted in the discourse section of the kata (labeled as `SUGGESTION`) and in the `#fixing` channel of the Codewars Discord.
3840

3941
### Review of a fork
4042

41-
After a fork with a fix is published and announced, it should draw attention of reviewers who will evaluate it and either approve it, or ask for further improvements.
43+
After a fork with a fix is published and announced, it should attract the attention of reviewers who will evaluate it and either approve it or request further improvements.
4244

4345
Users with sufficient privileges can approve their own forks without waiting for a review.
4446

45-
When a reviewer requests further improvements, they can be added to the same fork. It is not necessary to fork a fork if it hasn't been approved or rejected. However, if the fork has been merged and was found to require further improvements, it needs to be re-forked. Editing an approved fork is possible, but there is no way to merge the new changes into the kata.
47+
When a reviewer requests further improvements, they can be added to the same fork. It is not necessary to fork a fork if it hasn't been approved or rejected. However, if the fork has already been merged and further improvements are required, it must be re-forked. Editing an approved fork is possible, but there is no way to merge the new changes into the kata.
4648

4749
### Resources on fixing
4850

49-
Users who are interested with fixing Codewars challenges have some resources at their disposal:
51+
Users interested in fixing Codewars challenges have several resources at their disposal:
5052

51-
- [Codewars documentation](https://docs.codewars.com/),
52-
- [Authoring examples](https://www.codewars.com/collections/authoring-examples) collection,
53-
- Codewars Discord and its `#fixing` channel.
53+
- [Codewars documentation](https://docs.codewars.com/)
54+
- [Authoring examples](https://www.codewars.com/collections/authoring-examples) collection
55+
- Codewars Discord and its `#fixing` channel
5456

5557
### Community resources
5658

5759
:::info Note
58-
Community resources are created and maintained by Codewars users not affiliated with the platform. These resources are not maintained by Codewars, and can turn out to be outdated or not functional.
60+
Community resources are created and maintained by Codewars users not affiliated with the platform. These resources are not maintained by Codewars and may become outdated or non-functional.
5961
:::
6062

61-
- [Codot](https://github.com/hobovsky/codot-client/blob/main/README.md#fixing-forks-beta) an AI-powered assistant and its [fork refactoring](https://github.com/hobovsky/codot-client/blob/main/README.fixing.md#fixing-forks-with-codot-beta) function.
63+
- [Codot](https://github.com/hobovsky/codot-client/blob/main/README.md#fixing-forks-beta), an AI-powered assistant, and its [fork refactoring](https://github.com/hobovsky/codot-client/blob/main/README.fixing.md#fixing-forks-with-codot-beta) function.

0 commit comments

Comments
 (0)