Skip to content

Commit 6730167

Browse files
committed
Correct Link Anchor Syntax
1 parent 0f8e193 commit 6730167

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

CONTRIBUTING.adoc

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,38 +89,27 @@ We are excited for your pull request! :heart:
8989
Please do your best to follow these steps.
9090
Don't worry if you don't get them all correct the first time, we will help you.
9191

92-
[[sign-cla]]
93-
1. 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.
92+
1. [[sign-cla]] 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.
9493
For additional details, please refer to the blog post https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring[Hello DCO, Goodbye CLA: Simplifying Contributions to Spring].
95-
[[create-an-issue]]
96-
1. Must you https://github.com/spring-projects/spring-security/issues/new/choose[create an issue] first? No, but it is recommended for features and larger bug fixes. It's easier discuss with the team first to determine the right fix or enhancement.
94+
2. [[create-an-issue-list]] Must you https://github.com/spring-projects/spring-security/issues/new/choose[create an issue] first? No, but it is recommended for features and larger bug fixes. It's easier discuss with the team first to determine the right fix or enhancement.
9795
For typos and straightforward bug fixes, starting with a pull request is encouraged.
9896
Please include a description for context and motivation.
9997
Note that the team may close your pull request if it's not a fit for the project.
100-
[[choose-a-branch]]
101-
1. Always check out the branch indicated in the milestone and submit pull requests against it (for example, for milestone `5.8.3` use the `5.8.x` branch).
98+
3. [[choose-a-branch]] Always check out the branch indicated in the milestone and submit pull requests against it (for example, for milestone `5.8.3` use the `5.8.x` branch).
10299
If there is no milestone, choose `main`.
103100
Once merged, the fix will be forwarded-ported to applicable branches including `main`.
104-
[[create-a-local-branch]]
105-
1. Create a local branch
101+
4. [[create-a-local-branch]] Create a local branch
106102
If this is for an issue, consider a branch name with the issue number, like `gh-22276`.
107-
[[write-tests]]
108-
1. Add documentation and JUnit Tests for your changes.
109-
[[update-copyright]]
110-
1. In all files you edited, if the copyright header is of the form 2002-20xx, update the final copyright year to the current year.
111-
[[add-since]]
112-
1. If on `main`, add `@since` JavaDoc attributes to new public APIs that your PR adds
113-
[[change-rnc]]
114-
1. If you are updating the XSD, please instead update the RNC file and then run `./gradlew :spring-security-config:rncToXsd`.
115-
[[format-code]]
116-
1. For each commit, build the code using `./gradlew format check`.
103+
5. [[write-tests]] Add documentation and JUnit Tests for your changes.
104+
6. [[update-copyright]] In all files you edited, if the copyright header is of the form 2002-20xx, update the final copyright year to the current year.
105+
7. [[add-since]] If on `main`, add `@since` JavaDoc attributes to new public APIs that your PR adds
106+
8. [[change-rnc]] If you are updating the XSD, please instead update the RNC file and then run `./gradlew :spring-security-config:rncToXsd`.
107+
9. [[format-code]] For each commit, build the code using `./gradlew format check`.
117108
This command ensures the code meets most of <<code-style,the style guide>>; a notable exception is import order.
118-
[[commit-atomically]]
119-
1. Choose the granularity of your commits consciously and squash commits that represent
109+
10. [[commit-atomically]] Choose the granularity of your commits consciously and squash commits that represent
120110
multiple edits or corrections of the same logical change.
121111
See https://git-scm.com/book/en/Git-Tools-Rewriting-History[Rewriting History section of Pro Git] for an overview of streamlining the commit history.
122-
[[format-commit-messages]]
123-
1. Format commit messages using 55 characters for the subject line, 72 characters per line
112+
11. [[format-commit-messages]] Format commit messages using 55 characters for the subject line, 72 characters per line
124113
for the description, followed by the issue fixed, for example, `Closes gh-22276`.
125114
See the https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines[Commit Guidelines section of Pro Git] for best practices around commit messages, and use `git log` to see some examples.
126115
Present tense is preferred.

0 commit comments

Comments
 (0)