From ebb73a71fc1d582506e8fce6b250139c942d2af3 Mon Sep 17 00:00:00 2001 From: Robert Young Date: Fri, 8 Aug 2025 16:57:52 +1200 Subject: [PATCH] Add contribution section to README Signed-off-by: Robert Young --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e66d61b8..a5f5b09b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,21 @@ This is the repo containing the kroxylicious.io website. The site runs on Jekyll, so you'll need to ensure you have the [prerequisites](https://jekyllrb.com/docs/) installed to try it locally. 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. + +* [Kroxylicous.io Site](#kroxylicousio-site) + * [What?](#what) + * [Key Files](#key-files) + * [Development](#development) + * [Running in a Container](#running-in-a-container) + * [Building Production HTML](#building-production-html) + * [Running on GitHub Pages on a Fork](#running-on-github-pages-on-a-fork) +* [Binary content](#binary-content) +* [Excalidraw images](#excalidraw-images) +* [Redirects](#redirects) +* [Issues](#issues) +* [Contributing](#contributing) + + ## Key Files - [Gemfile](Gemfile) - required ruby gems for building and serving the site - [_config.yml](_config.yml) - Jekyll configuration for building the site @@ -86,4 +101,12 @@ mappings: fromVersion: 0.10.0 #Optional, if not specified the latest release at time of site build is used. toVersion: 0.12.0 #Optional, if not specified the latest release at time of site build is used. path: /html/kroxylicious-proxy/#con-configuring-client-connections-proxy # the path within the baseUrl -``` \ No newline at end of file +``` + +# Issues + +Issues are tracked in the `kroxylicious/kroxylicious` [Issue tracker](https://github.com/kroxylicious/kroxylicious/issues) + +# Contributing + +We welcome contributions! Please see our [contributing guidelines](https://github.com/kroxylicious/.github/blob/main/CONTRIBUTING.md) to get started. \ No newline at end of file