Skip to content

Fix README #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2025
Merged

Fix README #1035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Thanks for submitting a pull request! Please ensure that you have based your cod

- The current stable release branch for bugfixes of limited scope
- The upcoming [minor](https://semver.org) release branch for backwards compatible changes to existing functionality or addition of new functionality
- `master` for significant changes to existing behavior
- `3.x` for significant changes to existing behavior
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is better, but may make sense to explain diff b/w 2.x and 3.x -- 2.x being the default (main) branch.
And 2.x being for developing next 2.* minor version, 3.x for next 3.* minor version.

(esp. for README below)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... although this being in 3.x branch itself, maybe it's less confusing to just explain current branch. Your call. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very sorry, but I have been extremely busy lately and it has been difficult to check and make corrections (it is Sunday but I am about to go to work).
I think this was the template introduced from databind, so I feel that it could be replaced as is.


If you're unsure which branch to use, open an [issue](https://github.com/FasterXML/jackson-module-kotlin/issues) and ask, we're happy to talk over proposed changes.

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ when(root){
# Configuration

The Kotlin module may be given a few configuration parameters at construction time;
see the [inline documentation](https://github.com/FasterXML/jackson-module-kotlin/blob/master/src/main/kotlin/tools/jackson/module/kotlin/KotlinModule.kt)
see the [inline documentation](https://github.com/FasterXML/jackson-module-kotlin/blob/3.x/src/main/kotlin/tools/jackson/module/kotlin/KotlinModule.kt)
for details on what options are available and what they do.

```kotlin
Expand Down Expand Up @@ -247,7 +247,7 @@ across all Jackson components & modules. See the [jackson-databind README](https

We welcome any contributions—reports of issues, ideas for enhancements, and pull requests related to either of those.

See the [main Jackson contribution guidelines](https://github.com/FasterXML/jackson/blob/master/CONTRIBUTING.md) for more details.
See the [main Jackson contribution guidelines](https://github.com/FasterXML/jackson/blob/3.x/CONTRIBUTING.md) for more details.

### Branches

Expand All @@ -259,11 +259,11 @@ If you are going to write code, choose the appropriate base branch:

### Failing tests

There are a number of tests for functionality that is broken, mostly in the [failing](https://github.com/FasterXML/jackson-module-kotlin/tree/master/src/test/kotlin/com/fasterxml/jackson/module/kotlin/test/github/failing)
There are a number of tests for functionality that is broken, mostly in the [failing](https://github.com/FasterXML/jackson-module-kotlin/tree/3.x/src/test/kotlin/com/fasterxml/jackson/module/kotlin/test/github/failing)
package but a few as part of other test suites. Instead of ignoring these tests (with JUnit's `@Ignore` annotation)
or excluding them from being run as part of automated testing, the tests are written to demonstrate the failure
(either making a call that throws an exception or with an assertion that fails) but not fail the build, except if the
underlying issue is fixed. This allows us to know when the tested functionality has been incidentally fixed by
unrelated code changes.

See the [tests readme](https://github.com/FasterXML/jackson-module-kotlin/tree/master/src/test/kotlin/com/fasterxml/jackson/module/kotlin/README.md) for more information.
See the [tests readme](https://github.com/FasterXML/jackson-module-kotlin/tree/3.x/src/test/kotlin/com/fasterxml/jackson/module/kotlin/README.md) for more information.