Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

68 lines (40 loc) · 2.84 KB
Raw

Contributing

This gallery is intended to be a community-driven showcase of how Kroxylicious can be used and extended, so new contributions are always welcome.

You can help by:

  • Adding a link to your own Kroxylicious filter (see the style guide below),
  • Updating outdated links or removing broken links
  • Fixing spelling and grammar mistakes
  • Adding missing descriptions

...Or anything else you think might improve the gallery!

How to contribute

To make changes to the gallery you will need to open a pull request, but that's not the only way to contribute! Opening issues and starting discussions are also great ways to help out.

Gallery Style Guide

When adding a new filter to the gallery there are a few details that need to be included, like the name of the filter, where it can be found, and what it does.

Help us keep things neat and tidy by following this style checklist before opening a pull request:

  • New entries should start with a bullet point (*)
  • The title of each entry should be the name of the filter repository, including the owner's name (i.e. my-org/my-filter rather than just my-filter)
  • The title of each entry should be a link to the filter repository.
  • Each entry should include a short description of what the filter is or what it does (around 10 to 15 words is probably sufficient).
  • Entries where the filter has not been tested with the latest version of Kroxylicious should include the most recent version they were tested with.

Do:

 * [my-org/my-filter](https://example.com/my-org/my-filter): An example for illustrating the Kroxylicious Community Gallery style guide. *(Last tested on Kroxylicious v0.1.0)*
  • my-org/my-filter: An example for illustrating the Kroxylicious Community Gallery style guide. (Tested with Kroxylicious v0.1.0)

✅ The entry starts with a bullet point

✅ The title of the entry is the filter repository name

✅ The filter repository name includes the name of the owning organization

✅ The title of the entry is a link to the filter repository

✅ The entry has a short description of what the filter is

✅ The filter was not tested with the latest version of Kroxylicious, so the last tested Kroxylicious version is included at the end of the entry.

Don't:

my-filter https://example.com/my-org

My Filter https://example.com/my-org

❌ The entry doesn't start with a bullet point

❌ The title of the entry is not the filter repository name

❌ The title is not a link to the repository

❌ The link doesn't go to the filter repository

❌ There is no description of the filter

❌ There is no indication of whether the filter has been tested against the latest Kroxylicious version