You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,16 +31,27 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
31
31
To send us a pull request, please:
32
32
33
33
1. Fork the repository.
34
-
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.
34
+
2. Modify the source; please focus on a specific change in each pull request. If you incorporate multiple unrelated
35
+
features or reformat all the code, it will be hard for us to focus on your change.
35
36
* Ensure your modifications are accompanied by a [changelog entry](#Changelog) where necessary.
36
-
4. Ensure local tests pass.
37
-
5. Commit to your fork using clear commit messages.
38
-
6. Send us a pull request, answering any default questions in the pull request interface.
39
-
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
37
+
3. Ensure existing local tests pass. Add additional tests to cover the change.
38
+
4. Commit to your fork using clear commit messages.
39
+
5. Send us a pull request, answering any default questions in the pull request interface.
40
+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
40
41
41
42
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
42
43
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
43
44
45
+
### API and style guidelines
46
+
47
+
The AWS SDK for Kotlin is a multiplatform library intended to work for a wide variety of environments and use cases.
48
+
Please see JetBrains's Kotlin-specific
49
+
[library creators' guidelines](https://kotlinlang.org/docs/jvm-api-guidelines-introduction.html) for general guidance,
50
+
in particular the section on
51
+
[backward compatibility](https://kotlinlang.org/docs/jvm-api-guideliens-backward-compatibility.html). These guidelines
52
+
are not necessarily firm requirements which all contributions must follow, but you should be prepared to discuss PRs
53
+
which deviate from the guidelines.
54
+
44
55
### Changelog
45
56
Merges to this repository must include one or more changelog entries which describe the modifications made.
0 commit comments