Skip to content
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.

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

Fix TOC in CONTRIBUTING.md #41118

Merged
merged 1 commit into from
Jun 11, 2024
Merged
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports,
fixes, documentation, examples... But first, read this page (including the small print at the end).

<!-- toc -->

- [Legal](#legal)
- [Reporting an issue](#reporting-an-issue)
- [Checking an issue is fixed in main](#checking-an-issue-is-fixed-in-main)
Expand All @@ -20,8 +22,8 @@ fixes, documentation, examples... But first, read this page (including the small
+ [Eclipse Setup](#eclipse-setup)
+ [IDEA Setup](#idea-setup)
- [How to work](#how-to-work)
- [`OutOfMemoryError` while importing](#-outofmemoryerror--while-importing)
- [`package sun.misc does not exist` while building](#-package-sunmisc-does-not-exist--while-building)
- [`OutOfMemoryError` while importing](#outofmemoryerror-while-importing)
- [`package sun.misc does not exist` while building](#package-sunmisc-does-not-exist-while-building)
- [Formatting](#formatting)
* [Gitpod](#gitpod)
- [Build](#build)
Expand All @@ -32,19 +34,22 @@ fixes, documentation, examples... But first, read this page (including the small
+ [Running a single test](#running-a-single-test)
- [Maven Invoker tests](#maven-invoker-tests)
* [Build with multiple threads](#build-with-multiple-threads)
* [Don't build any test modules](#don-t-build-any-test-modules)
* [Don't build any test modules](#dont-build-any-test-modules)
+ [Automatic incremental build](#automatic-incremental-build)
- [Special case `bom-descriptor-json`](#special-case--bom-descriptor-json-)
- [Special case `bom-descriptor-json`](#special-case-bom-descriptor-json)
- [Usage by CI](#usage-by-ci)
- [Develocity build cache](#develocity-build-cache)
* [Getting set up](#getting-set-up)
* [-Dquickly](#-dquickly)
* [Benchmarking the build](#benchmarking-the-build)
- [Release your own version](#release-your-own-version)
- [Documentation](#documentation)
* [Building the documentation](#building-the-documentation)
* [Referencing a new guide in the index](#referencing-a-new-guide-in-the-index)
- [Usage](#usage)
+ [With Maven](#with-maven)
+ [With Gradle](#with-gradle)
* [MicroProfile TCK's](#microprofile-tck-s)
* [MicroProfile TCK's](#microprofile-tcks)
* [Test Coverage](#test-coverage)
- [Extensions](#extensions)
* [Descriptions](#descriptions)
Expand All @@ -53,7 +58,8 @@ fixes, documentation, examples... But first, read this page (including the small
- [The small print](#the-small-print)
- [Frequently Asked Questions](#frequently-asked-questions)

<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
<!-- tocstop -->
<small><i><a href='https://github.com/jonschlinkert/markdown-toc'>Table of contents generated with markdown-toc</a></i></small>

## Legal

Expand Down