Skip to content

Commit 5b0cab1

Browse files
committed
update Contributing guide
1 parent e9ec4a0 commit 5b0cab1

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1-
# CONTRIBUTING
1+
# Contributing to kotlin-logging
22

3-
Pull requests are welcome!
4-
Before submitting a PR, it is usually better to discuss your intentions either by opening a new issue or in [slack](https://kotlinlang.slack.com/messages/kotlin-logging/).
3+
We welcome and appreciate all contributions, from bug fixes to new features. To ensure a smooth and effective process for everyone, please take a moment to review these guidelines.
4+
5+
## Guiding Principles
6+
7+
* **Discuss First:** Before starting any significant work, please open an issue to discuss your proposed changes. This allows us to align on the problem and the proposed solution before you invest your time in writing code. This is especially important for new features, refactorings, or complex changes.
8+
* **Small, Incremental Changes:** We strongly prefer small, focused pull requests (PRs) that address a single issue or add a single, well-defined piece of functionality.
9+
* **Embrace Iteration:** Large features or refactorings should be broken down into a series of smaller, logical PRs that can be reviewed and merged independently.
10+
11+
### Why Small Pull Requests?
12+
13+
* **Easier to Review:** A small, focused PR is much faster and easier for maintainers to review thoroughly.
14+
* **Lower Risk:** Smaller changes are less likely to introduce unintended side effects and are easier to revert if necessary.
15+
* **Faster Merging:** It is much easier to get a small change approved and merged, delivering value to users more quickly.
16+
17+
## Submitting a Pull Request
18+
19+
1. **Fork the repository** and create your branch from `master`.
20+
2. **Open an issue** to discuss your proposed changes (if one doesn't already exist).
21+
3. **Make your changes** in a new git branch.
22+
4. **Write Tests:** Ensure your changes are covered by new or existing tests.
23+
5. **Ensure the test suite passes:** Run `./gradlew clean build` locally.
24+
6. **Check and apply formatting:** Run `./gradlew spotlessApply`.
25+
7. **Commit your changes** and push to your fork.
26+
8. **Open a PR** to the `master` branch. In the PR description, please link to the issue you are addressing.
27+
28+
Thank you for helping make kotlin-logging better!
529

630
# Building locally
731

@@ -14,4 +38,3 @@ To check formatting:
1438
To fix formatting:
1539

1640
`./gradlew spotlessApply`
17-

0 commit comments

Comments
 (0)