Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the main branch.
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
To send us a pull request, please:
- Fork the repository.
- Modify the source; please focus on a specific change in each pull request. If you incorporate multiple unrelated
features or reformat all the code, it will be hard for us to focus on your change.
- Ensure your modifications are accompanied by a changelog entry where necessary.
- Ensure existing local tests pass. Add additional tests to cover the change.
- Commit to your fork using clear commit messages.
- Send us a pull request, answering any default questions in the pull request interface.
- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
GitHub provides additional document on forking a repository and creating a pull request.
Smithy Kotlin's generated code is multiplatform and intended to work for a wide variety of environments and use cases. Please see JetBrains's Kotlin-specific library creators' guidelines for general guidance, in particular the section on backward compatibility. These guidelines are not necessarily firm requirements which all contributions must follow, but you should be prepared to discuss PRs which deviate from the guidelines.
Merges to this repository must include one or more changelog entries which describe the modifications made.
Entries are placed in the top-level .changes/ directory. An entry is a file containing a JSON object with the
following fields:
| Field name | Type | Required | Enum | Description |
|---|---|---|---|---|
id |
string |
yes | A unique identifier for this entry. We recommend you generate a UUID for this field. | |
type |
string |
yes | bugfix, feature, documentation, misc |
The type of change being made. |
description |
string |
yes | A description of the change being made.
|
|
issues |
string[] |
no | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:
|
|
module |
string |
no | The area of the code affected by your changes. If unsure, leave this value unset. | |
requiresMinorVersionBump |
boolean |
no | Indicates the change will require a new minor version. This is usually the case after a breaking change. Defaults to false if flag is not included. |
The filename of an entry is arbitrary. We recommend <id>.json, where <id> corresponds to the id field of the entry
itself.
Entries in the .changes/ directory are automatically rolled into the main CHANGELOG.md file in every release.
If you believe that your modifications do not warrant a changelog entry, you can add the no-changelog label to your
pull request. The label will suppress the CI that blocks merging in the absence of a changelog, though the reviewer(s)
of your request may disagree and ask that you add one anyway.
{
"id": "263ea6ab-4b75-41a8-9c37-821c30d7b9e5",
"type": "feature",
"description": "Add multiplatform support for URL parsing",
"issues": [
"awslabs/smithy-kotlin#12345"
]
}When submitting a pull request please have your commits follow these guidelines:
This project uses conventional commits for its commit message format and expects all contributors to follow these guidelines.
Each commit message consists of a header, a body (optional), and a footer (optional). The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Any line of the commit message should not be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
- ci: Changes to CI/CD scripts and tooling
The scope is optional but should be included when possible and refer to a module that is being touched. Examples:
- codegen
- rt (optionally the target platform e.g. rt-android)
The subject contains succinct description of the change:
- Use the imperative present tense (e.g., "change" not "changed" nor "changes")
- Don't capitalize first letter
- No dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
The last line of commits introducing breaking changes should be in the form BREAKING CHANGE: <desc>
Breaking changes should also add an exclamation mark ! after the type/scope (e.g. refactor(rt)!: drop support for Android API < 20)
A number of automated workflows run when a PR is submitted. Generally speaking, each of these must pass before the PR is allowed to be merged. If your PR fails one of the checks, please attempt to address the problem and push a new commit to the PR. If you need help understanding or resolving a PR check failure, please reach out via a PR comment or a GitHub discussion. Please file a new issue if you believe there's a pre-existing bug in a PR check.
This repo uses ktlint (via the
ktlint Gradle plugin). To run a lint check locally, run
./gradlew ktlint.
To verify cross-OS compatibility, we build our code against Linux, MacOS, and Windows runners provided by GitHub.
Running these checks independently requires access to hosts with those operating systems. On a host with the correct
operating system, run ./gradlew build.
This repo is a core dependency of aws-sdk-kotlin and many changes made here could impact that repo as well. To ensure that aws-sdk-kotlin continues to function correctly, we run a downstream CI check that builds both code bases in a shared workspace. To run this check locally, check out both repositories into subdirectories of the same parent, build/publish smithy-kotlin followed by aws-sdk-kotlin, and then run the protocol tests. For example:
mkdir path/to/workspace # create a new directory to hold both repositories
cd path/to/workspace
git clone -b branch-name https://github.com/smithy-lang/smithy-kotlin.git # replace branch-name as appropriate
git clone -b branch-name https://github.com/awslabs/aws-sdk-kotlin.git # replace branch-name as appropriate
cd smithy-kotlin
./gradlew build publishToMavenLocal
cd ../aws-sdk-kotlin
./gradlew build publishToMavenLocal testAllProtocolsNote: Replace branch-name in the above commands with the actual names of your branches. When making linked changes
across both repos, it's best to create/use the same branch name in both locations.
This check enforces the changelog requirements described above.
This repository uses Kotlin's binary compatibility validator plugin to help preserve backwards compatibility across releases.
The plugin will automatically run during a build with no extra steps needed from the developer. If a backwards incompatible change is introduced, the build will fail.
If the backwards incompatibility is expected, the appropriate .api files must be updated as part of the PR.
The .api files can be updated by running ./gradlew apiDump.
The binary compatibility validator can also be run manually using ./gradlew apiCheck.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
We may ask you to sign a Contributor License Agreement (CLA) for larger changes.