Skip to content

Add contribution section to README #187

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.

Sign up for GitHub

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

Merged
robobario merged 1 commit into from
Aug 14, 2025
Merged

Add contribution section to README #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- TOC -->
* [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)
<!-- TOC -->

## Key Files
- [Gemfile](Gemfile) - required ruby gems for building and serving the site
- [_config.yml](_config.yml) - Jekyll configuration for building the site
Expand Down Expand Up @@ -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
```
```

# 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.