Skip to content

Commit 23937cd

Browse files
fix: address colleague feedback on hub contributing docs
- Remove cscli hubtest coverage command that shows 0% and lacks filtering - Remove ChatGPT remnants and unclear language - Simplify PR checklist to avoid template duplication - Remove vague performance troubleshooting item - Remove redundant benefits section for cleaner flow
1 parent 49d905f commit 23937cd

File tree

1 file changed

+2
-30
lines changed
  • crowdsec-docs/docs/contributing

1 file changed

+2
-30
lines changed

crowdsec-docs/docs/contributing/hub.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -137,13 +137,6 @@ The hub repository uses GitHub Actions for automated testing:
137137
- Tests include syntax validation, pattern matching, and integration tests
138138
- Make sure all tests pass before requesting review
139139

140-
### Test Coverage
141-
142-
Check test coverage for your contributions:
143-
144-
```bash
145-
cscli hubtest coverage
146-
```
147140

148141
## Git Workflow / Branch Management
149142

@@ -236,17 +229,6 @@ nodes:
236229
value: user_enumeration
237230
```
238231

239-
#### Benefits of Using Statics
240-
241-
Yes, we understand that using YAML anchors makes the YAML DRY but it can introduce complexity.
242-
243-
- **Better maintainability**: Static values are clearly defined at the top level
244-
- **Automatic key handling**: If a static returns empty data, the key will not be set (as you mentioned)
245-
- **Cleaner structure**: Avoids YAML complexity and improves readability
246-
- **Consistent patterns**: Follows established CrowdSec conventions
247-
- **Proper targeting**: Statics can target `meta`, `parsed`, or `enriched` fields directly
248-
- **Expression support**: Can use expressions to derive values dynamically
249-
250232
### AI-Assisted Generation
251233

252234
We do allow AI-assisted generation of parsers, scenarios, and collections, but with important requirements:
@@ -291,7 +273,7 @@ Collections group related parsers, scenarios, and postoverflows together. It oft
291273

292274
#### When to add to existing collections:
293275

294-
- Adding a parser for `SpecificWebServer` access logs that would benefit from [all the default http related scenarios](https://hub.crowdsec.net/author/crowdsecurity/collections/base-http-scenarios)
276+
- Adding a parser for a specific web server's access logs that would benefit from existing HTTP-related scenarios
295277
- Your contribution enhances an existing service's detection capabilities
296278
- Your scenario complements existing parsers in a collection
297279

@@ -391,16 +373,7 @@ Everything is all set, you can now open a PR that will be reviewed and merged!
391373

392374
### PR Checklist
393375

394-
Before opening your PR, ensure you can check all items in the [PR template](https://github.com/crowdsecurity/hub/blob/master/.github/pull_request_template.md):
395-
396-
- [ ] I have read the [contributing guide](https://docs.crowdsec.net/docs/next/contributing/contributing_hub)
397-
- [ ] I have tested my changes locally
398-
- [ ] For new parsers or scenarios, tests have been added
399-
- [ ] I have run the hub linter and no issues were reported (see contributing guide)
400-
- [ ] Automated tests are passing
401-
- [ ] AI was used to generate any/all content of this PR (if applicable)
402-
403-
#### Additional Requirements
376+
Before opening your PR, ensure you can check all items in the [PR template](https://github.com/crowdsecurity/hub/blob/master/.github/pull_request_template.md). Additional requirements:
404377

405378
- [ ] Documentation is complete and accurate
406379
- [ ] Code follows the project's style guidelines
@@ -423,7 +396,6 @@ Before opening your PR, ensure you can check all items in the [PR template](http
423396

424397
- **Grok patterns not matching**: Use online grok testers to validate patterns
425398
- **Missing fields**: Ensure all required fields are extracted
426-
- **Performance**: Optimize grok patterns for better performance
427399

428400
#### Scenario Issues
429401

0 commit comments

Comments
 (0)