Skip to content

Commit a65967a

Browse files
Inegogoodwinnk
authored andcommitted
Mention the master branch as the target of pull requests in contributing.md. (JetBrains#2533)
Also, improve grammar a bit in the same guide.
1 parent 7eac7d9 commit a65967a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
We love contributions! There's [lots to do on Kotlin](https://youtrack.jetbrains.com/issues/KT) and on the
3+
We love contributions! There is [a lot to do on Kotlin](https://youtrack.jetbrains.com/issues/KT) and on the
44
[standard library](https://youtrack.jetbrains.com/issues/KT?q=%23Kotlin%20%23Unresolved%20and%20(links:%20KT-2554,%20KT-4089%20or%20%23Libraries)) so why not chat with us
55
about what you're interested in doing? Please join the #kontributors channel in [our Slack chat](http://slack.kotlinlang.org/)
66
and let us know about your plans.
@@ -12,7 +12,7 @@ Currently only committers can assign issues to themselves so just add a comment
1212
A nice gentle way to contribute would be to review the [standard library docs](https://kotlinlang.org/api/latest/jvm/stdlib/index.html)
1313
and find classes or functions which are not documented very well and submit a patch.
1414

15-
In particular it'd be great if all functions included a nice example of how to use it such as for the
15+
In particular, it'd be great if all functions included a nice example of how to use it such as for the
1616
[`hashMapOf()`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/hash-map-of.html) function.
1717
This is implemented using the [`@sample`](https://github.com/JetBrains/kotlin/blob/1.1.0/libraries/stdlib/src/kotlin/collections/Maps.kt#L91)
1818
macro to include code from a test function. The benefits of this approach are twofold; First, the API's documentation is improved via beneficial examples that help new users and second, the code coverage is increased.
@@ -26,7 +26,7 @@ If you want to contribute a new language feature, it is important to discuss it
2626
## Submitting patches
2727

2828
The best way to submit a patch is to [fork the project on GitHub](https://help.github.com/articles/fork-a-repo/) and then send us a
29-
[pull request](https://help.github.com/articles/creating-a-pull-request/) via [GitHub](https://github.com).
29+
[pull request](https://help.github.com/articles/creating-a-pull-request/) to the `master` branch via [GitHub](https://github.com).
3030

3131
If you create your own fork, it might help to enable rebase by default
3232
when you pull by executing
@@ -39,7 +39,7 @@ which will help keep your pull request simple and easy to apply.
3939
## Intention/QuickFix/Inspection
4040

4141
Please read the [Intention/QuickFix/Inspection Quick Notes](intentions_inspections_quickfixes.md) if you are
42-
going to implement inspection, intention or add a quick fix.
42+
going to implement an inspection or intention or add a quick fix.
4343

4444
## Checklist
4545

0 commit comments

Comments
 (0)