mandiant / mandiant/capa-rules
add reference to capa install instructions to PR suggestions
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 736
- Forks
- 245
- Avg merge
- 4d 53m
- Merged PRs (30d)
- 2
Description
On another note. I noticed when trying to do a pull request, it gave a few tips, such as running lint.py from the scripts section The issue was, I only cloned the capa-rules repo, so it didn't have that scripts folder in it, as that's in the capa repo
This can be confusing to new users who went straight to writing capa rules without checking out the capa docs first.
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
Start by locating the pull-request suggestion text in this repository and compare its lint.py guidance with the capa installation documentation referenced in the issue. Update the suggestion to point new contributors to those installation instructions, then verify that the resulting guidance is clear for someone who cloned only capa-rules.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100