Skip to content

Commit b0af403

Browse files
authored
docs(CONTRIBUTING.md): enhance guidelines clarity and grammar (#2361)
1 parent 9056f30 commit b0af403

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Submit issues [here](https://github.com/Kotlin/kotlinx.serialization/issues).
2222
* Use a 'feature request' template when creating a new issue.
2323
* Explain why you need the feature — what's your use-case, what's your domain.
2424
* Explaining the problem you face is more important than suggesting a solution.
25-
Report your problem even if you don't have any proposed solution.
25+
Even if you don't have a proposed solution, please report your problem.
2626
* If there is an alternative way to do what you need, then show the code of the alternative.
2727

2828
## Submitting PRs
@@ -40,7 +40,7 @@ so do familiarize yourself with the following guidelines.
4040
* If you fix documentation:
4141
* After fixing/changing code examples in the [`docs`](docs) folder or updating any references in the markdown files
4242
run the [Knit tool](#running-the-knit-tool) and commit the resulting changes as well.
43-
It will not pass the tests otherwise.
43+
Your changes will not pass the tests otherwise.
4444
* If you plan extensive rewrites/additions to the docs, then please [contact the maintainers](#contacting-maintainers)
4545
to coordinate the work in advance.
4646
* If you make any code changes:
@@ -49,7 +49,7 @@ so do familiarize yourself with the following guidelines.
4949
* Use imports with '*'.
5050
* [Build the project](#building) to make sure it all works and passes the tests.
5151
* If you fix a bug:
52-
* Write the test the reproduces the bug.
52+
* Write the test that reproduces the bug.
5353
* Fixes without tests are accepted only in exceptional circumstances if it can be shown that writing the
5454
corresponding test is too hard or otherwise impractical.
5555
* Follow the style of writing tests that is used in this project:
@@ -69,7 +69,7 @@ so do familiarize yourself with the following guidelines.
6969
* You can submit a PR to the [list of community-supported formats](formats/README.md#other-community-supported-formats)
7070
with a description of your library.
7171
* Comment on the existing issue if you want to work on it. Ensure that the issue not only describes a problem,
72-
but also describes a solution that had received a positive feedback. Propose a solution if there isn't any.
72+
but also describes a solution that has received positive feedback. Propose a solution if there isn't any.
7373

7474
## Building
7575

0 commit comments

Comments
 (0)