Skip to content

Commit 0510cc7

Browse files
authored
chore: update CONTRIBUTING guidelines to talk about more PR criteria (#990)
1 parent 2465db5 commit 0510cc7

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,27 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
4646
To send us a pull request, please:
4747

4848
1. Fork the repository.
49-
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
49+
2. Modify the source; please focus on a specific change in each pull request. If you incorporate multiple unrelated
50+
features or reformat all the code, it will be hard for us to focus on your change.
5051
* Ensure your modifications are accompanied by a [changelog entry](#Changelog) where necessary.
51-
3. Ensure local tests pass.
52+
3. Ensure existing local tests pass. Add additional tests to cover the change.
5253
4. Commit to your fork using clear commit messages.
5354
5. Send us a pull request, answering any default questions in the pull request interface.
5455
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
5556

5657
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
5758
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
5859

60+
### API and style guidelines
61+
62+
The AWS SDK for Kotlin is a multiplatform library intended to work for a wide variety of environments and use cases.
63+
Please see JetBrains's Kotlin-specific
64+
[library creators' guidelines](https://kotlinlang.org/docs/jvm-api-guidelines-introduction.html) for general guidance,
65+
in particular the section on
66+
[backward compatibility](https://kotlinlang.org/docs/jvm-api-guideliens-backward-compatibility.html). These guidelines
67+
are not necessarily firm requirements which all contributions must follow, but you should be prepared to discuss PRs
68+
which deviate from the guidelines.
69+
5970
### Changelog
6071
Merges to this repository must include one or more changelog entries which describe the modifications made.
6172

0 commit comments

Comments
 (0)