Skip to content

Commit 4bcf42a

Browse files
Polish README.md and CONTRIBUTING.adoc
Signed-off-by: Tran Ngoc Nhan <[email protected]>
1 parent 9c3718d commit 4bcf42a

File tree

2 files changed

+8
-25
lines changed

2 files changed

+8
-25
lines changed

CONTRIBUTING.adoc

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For additional details, please refer to the blog post https://spring.io/blog/202
3232

3333
1. Go to https://github.com/spring-projects/spring-kafka[https://github.com/spring-projects/spring-kafka]
3434
2. Hit the "fork" button and choose your own GitHub account as the target
35-
3. For more detail see https://help.github.com/fork-a-repo/[Fork A Repo].
35+
3. For more detail see https://help.github.com/articles/fork-a-repo/[Fork A Repo].
3636

3737
== Setup your Local Development Environment
3838

@@ -153,7 +153,7 @@ Please carefully follow the whitespace and formatting conventions already presen
153153
[source, java]
154154
----
155155
/*
156-
* Copyright 2016 the original author or authors.
156+
* Copyright 2025-present the original author or authors.
157157
*
158158
* Licensed under the Apache License, Version 2.0 (the "License");
159159
* you may not use this file except in compliance with the License.
@@ -171,26 +171,9 @@ Please carefully follow the whitespace and formatting conventions already presen
171171
package ...;
172172
----
173173

174-
== Update license header to modified files as necessary
174+
== Use `@since` tags
175175

176-
Always check the date range in the Apache license header. For example, if you've modified a file in 2016 whose header
177-
still reads
178-
179-
[source java]
180-
----
181-
* Copyright 2002-2011 the original author or authors.
182-
----
183-
184-
then be sure to update it to 2016 appropriately
185-
186-
[source java]
187-
----
188-
* Copyright 2002-2016 the original author or authors.
189-
----
190-
191-
== Use @since tags
192-
193-
Use @since tags for newly-added public API types and methods e.g.
176+
Use `@since` tags for newly-added public API types and methods e.g.
194177

195178
[source java]
196179
----

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ Please help out on the [StackOverflow](https://stackoverflow.com/questions/tagge
7171
* Create [GitHub issues](https://github.com/spring-projects/spring-kafka/issues) for bugs and new features and comment and vote on the ones that you are interested in.
7272
* GitHub is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/).
7373
If you want to contribute code this way, please reference a GitHub issue as well covering the specific issue you are addressing.
74-
* Watch for upcoming articles on Spring by [subscribing](https://www.springsource.org/node/feed) to springframework.org
7574

76-
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup).
77-
Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
75+
All commits must include a _Signed-off-by_ trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin.
76+
For additional details, please refer to the blog post [Hello DCO, Goodbye CLA: Simplifying Contributions to Spring](https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring).
77+
The DCO does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.
7878
Active contributors might be asked to join the core team and given the ability to merge pull requests.
7979

8080
## Code Conventions and Housekeeping
@@ -95,4 +95,4 @@ Use the [`spring-kafka` tag on Stack Overflow](https://stackoverflow.com/questio
9595

9696
# License
9797

98-
Spring Kafka is released under the terms of the Apache Software License Version 2.0 (see LICENSE.txt).
98+
Spring Kafka is released under the terms of the Apache Software License Version 2.0 (see [LICENSE.txt](LICENCE.txt)).

0 commit comments

Comments
 (0)