Skip to content

Add contribution guidelines#587

Merged
dkhalanskyjb merged 1 commit into
masterfrom
dkhalanskyjb/contributing
May 4, 2026
Merged

Add contribution guidelines#587
dkhalanskyjb merged 1 commit into
masterfrom
dkhalanskyjb/contributing

Conversation

@dkhalanskyjb
Copy link
Copy Markdown
Collaborator

No description provided.

@fzhinkin
Copy link
Copy Markdown
Contributor

fzhinkin commented Nov 10, 2025

For other libraries, like kotlinx-coroutines, we provide a more-or-less detailed overview of what needs to be done before submitting a pull request (like, running tests locally, choosing a target branch for a pull requests, aligning code style with our conventions, etc.).
While we're explicit about not accepting PRs with new features, such information could be helpful for those who's willing to fix bugs or update documentation. Should we include it into the contribution guideline?

@fzhinkin
Copy link
Copy Markdown
Contributor

@dkhalanskyjb, WDYT about #587 (comment)?

@dkhalanskyjb
Copy link
Copy Markdown
Collaborator Author

Honestly, nothing comes to mind. kotlinx.coroutines has some opaque rules (naming conventions for tests, using develop as the target most of the time but not always, etc.), but kotlinx-datetime is very lenient. Tests are named reasonably but without a strong convention, the default branch is always the PR target, the style is also mostly just https://kotlinlang.org/docs/coding-conventions.html.

We could try listing even these aspects, but I'd prefer to avoid adding text with obvious information, to decrease the risk that the contributors get intimidated and skip reading the guidelines entirely. If we witness a contributor making a mistake, we can always update the guidelines later in reaction to that.

@dkhalanskyjb dkhalanskyjb merged commit edc1183 into master May 4, 2026
1 check passed
@dkhalanskyjb dkhalanskyjb deleted the dkhalanskyjb/contributing branch May 4, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants