Remediation Components
Publishing remediation component
We do welcome remediation components from the community, and will gladly publish them on the hub.
Why ?
Sharing on the hub allows other users to find and use it. While increasing your code's visibility, it also ensures a benevolent evaluation by the community and our team.
How ?
To have it published on the hub, please simply open a new issue on the hub, requesting "remediation component inclusion". The remediation component will then be reviewed by the team, and published directly on the hub, for everyone to find & use it!
The information that should be stated in your issue is:
- Source repository of your remediation component (for example
https://github.com/crowdsecurity/cs-firewall-bouncer/
) - Software licence used
- Current status of the remediation component (stage: dev/unstable/stable)
- Documentation (can be simply in the README.md):
- must contain: installing, uninstalling
- should contain: configuration documentation
- Link to existing tests if applicable (either functional or unit tests)
Please take care of the following :
- Ensure your repository has a About/Short description meaningful enough: it will be displayed in the hub
- Ensure your repository has a decent README.md file: it will be displayed in the hub
- Ensure your repository has at least one release: this is what users will be looking for
- (ideally) Have a "social preview image" on your repository: this will be displayed in the hub when available
- (ideally) A Howto or link to a guide that provides a hands-on experience with the remediation component
You can follow this template:
Hello,
I would like to suggest the addition of the `XXXX` to the hub :
- Source repository: https://github.com/xxx/xxx/
- Licence: MIT
- Current status: stable (has been used in production for a while)
- README/doc: https://github.com/xxx/xxx/blob/main/README.md
- Existing tests:
- functional tests: https://github.com/xxx/xxx/blob/main/.github/workflows/tests.yml
- Short/Long description: OK
- Howto: in README
- At least one release: yes
Bonus
You can also open a Pull Request to add the remediation component in the Hub.
To do this, you must edit the blockers/list.json
file and add the following object in the array:
{
"name": "<BOUNCER NAME>",
"author": "<GITHUB ACCOUNT OR ORG>",
"logo": "<THE BASE64 LOGO IMAGE>"
}