mandiant / mandiant/capa-rules
Articles in rule names are used inconsistently
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 736
- Forks
- 245
- Avg merge
- 4d 53m
- Merged PRs (30d)
- 2
Description
I noticed that the usage of indefinite articles in rule names is quite inconsistent in the current rule base. E.g. `create-process.yml` is not using an article but `create-a-process-with-modified-io-handles-and-window.yml` is using one. This can be addressed in the future to make the rule base more consistent and to not confuse rule contributors. ;D
_Originally posted by @0x534a in https://github.com/fireeye/capa-rules/issues/225#issuecomment-763180944_
We should document this and clean up the rule names afterwards.
My preference is to omit `a` and `an` in rule names even though it goes against the current "complete this sentence" philosophy. I'd adjust this to "complete this sentence, but without a/an". Currently about 20 rules contain `a` or `an`.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No specific files or tests are named. Search the rule base for names containing `a` or `an`, review the existing naming philosophy, then document the agreed convention and identify the roughly 20 affected rules. Done means the convention is documented and the affected rule names consistently omit indefinite articles.
Written by the indexing model from the issue text.
Assessment
- Domain
- security
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100