Skip to content

Commit c88e647

Browse files
committed
Merge branch 'develop'
# Conflicts: # README.md
2 parents 0123850 + f0912a7 commit c88e647

File tree

221 files changed

+15999
-8503
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+15999
-8503
lines changed

.teamcity/pom.xml

Lines changed: 0 additions & 104 deletions
This file was deleted.

.teamcity/settings.kts

Lines changed: 0 additions & 239 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing Guidelines
2+
3+
One can contribute to the project by reporting issues or submitting changes via pull request.
4+
5+
## Reporting issues
6+
7+
Please use [GitHub issues](https://github.com/Kotlin/kotlinx-io/issues) for filing feature requests and bug reports.
8+
9+
Questions about usage and general inquiries are better suited for StackOverflow or the #io channel in KotlinLang Slack.
10+
11+
## Submitting changes
12+
13+
Submit pull requests [here](https://github.com/Kotlin/kotlinx-io/pulls).
14+
However, please keep in mind that maintainers will have to support the resulting code of the project,
15+
so do familiarize yourself with the following guidelines.
16+
17+
* If you make any code changes:
18+
* Follow the [Kotlin Coding Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
19+
* Use 4 spaces for indentation.
20+
* Use imports with '*'.
21+
* [Build the project](#building) to make sure it all works and passes the tests.
22+
* If you fix a bug:
23+
* Write the test the reproduces the bug.
24+
* Fixes without tests are accepted only in exceptional circumstances if it can be shown that writing the
25+
corresponding test is too hard or otherwise impractical.
26+
* Follow the style of writing tests that is used in this project:
27+
name test functions as `testXxx`. Don't use backticks in test names.
28+
* Comment on the existing issue if you want to work on it. Ensure that the issue not only describes a problem,
29+
but also describes a solution that had received a positive feedback. Propose a solution if there isn't any.
30+
31+
## Building
32+
33+
This library is built with Gradle.
34+
35+
* Run `./gradlew build` to build. It also runs all the tests.
36+
* Run `./gradlew <module>:check` to test the module you are looking at to speed
37+
things up during development.
38+
* Run `./gradlew <module>:jvmTest` to perform only the fast JVM tests of a multiplatform module.
39+
40+
You can import this project into IDEA, but you have to delegate build actions
41+
to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Build and run).
42+
43+
### Updating the public API dump
44+
45+
* Use the [Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator/blob/master/README.md) for updates to public API:
46+
* Run `./gradlew apiDump` to update API index files.
47+
* Commit the updated API indexes together with other changes.

0 commit comments

Comments
 (0)