node-formidable / node-formidable/formidable
Add virus scanning example to documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7.2k
- Forks
- 689
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 2
Description
Hi, formidable is great for handling multipart uploads. One gap
in the ecosystem is documentation around scanning uploaded files
for malware before saving them.
I built pompelmi (https://github.com/pompelmi/pompelmi) — a
zero-dependency ClamAV wrapper for Node.js that integrates cleanly
with formidable's streaming API. Would a security section in the
docs be welcome? Happy to open a PR.
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 documentation file or test is named. Review the existing documentation structure and formidable's streaming API guidance first, then determine where a security section and the proposed Node.js ClamAV example fit. Done means an agreed, reviewed example that explains scanning uploaded files before saving them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100