Skip to content

Commit 7f86e9a

Browse files
committed
Add contribution section to README
Signed-off-by: Robert Young <[email protected]>
1 parent 84a381a commit 7f86e9a

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ This is the repo containing the kroxylicious.io website.
66
The site runs on Jekyll, so you'll need to ensure you have the [prerequisites](https://jekyllrb.com/docs/) installed to try it locally.
77
You'll also need to ensure you have Ruby 3.2+ installed, along with the latest versions of Rake and Bundler for your Ruby distribution.
88

9+
<!-- TOC -->
10+
* [Kroxylicous.io Site](#kroxylicousio-site)
11+
* [What?](#what)
12+
* [Key Files](#key-files)
13+
* [Development](#development)
14+
* [Running in a Container](#running-in-a-container)
15+
* [Building Production HTML](#building-production-html)
16+
* [Running on GitHub Pages on a Fork](#running-on-github-pages-on-a-fork)
17+
* [Binary content](#binary-content)
18+
* [Excalidraw images](#excalidraw-images)
19+
* [Redirects](#redirects)
20+
* [Contributing](#contributing)
21+
<!-- TOC -->
22+
923
## Key Files
1024
- [Gemfile](Gemfile) - required ruby gems for building and serving the site
1125
- [_config.yml](_config.yml) - Jekyll configuration for building the site
@@ -86,4 +100,14 @@ mappings:
86100
fromVersion: 0.10.0 #Optional, if not specified the latest release at time of site build is used.
87101
toVersion: 0.12.0 #Optional, if not specified the latest release at time of site build is used.
88102
path: /html/kroxylicious-proxy/#con-configuring-client-connections-proxy # the path within the baseUrl
89-
```
103+
```
104+
105+
# Contributing
106+
107+
You can contribute by:
108+
109+
* Raising any issues you find in the [Issue tracker](https://github.com/kroxylicious/kroxylicious/issues)
110+
* Fixing issues by opening Pull Requests
111+
* Improving documentation (note that release-specific documentation lives in [kroxylicous/kroxylicious](https://github.com/kroxylicious/kroxylicious/tree/main/docs))
112+
113+
Check out our [Join Us](https://kroxylicious.io/join-us/) page for more information on contributing to the project!

0 commit comments

Comments
 (0)