Getting Started

This page will walk you through getting started with the Contributor program

To jump right to the list of project proposals, click here.

Table of Contents:

• Account Registration and Setup
• Choose a Project
• Work Your Magic (Analyze Malware / Write Coverage)
• Have Your Work Reviewed
• Give Yourself Credit

Account Registration and Setup

• Sign up for a GitHub account. Project proposals are managed through GitHub, so you’ll need an account to participate.
• Register a Freenode.net nickname. Having a registered nickname will allow you to access the #snort and #clamav channels in case you need to ask questions.
• Register for a MalShare API Key. This will allow you to download malware referenced in the project proposals.
• To contribute new Snort rules, you’ll need to join the snort-sigs mailing list. Also, consider joining the snort-users mailing list if you’d like another avenue for asking Snort-related questions.
• To contribute new ClamAV signatures, you’ll need to join the community-sigs mailing list. Also, consider joining the ClamAV Discord Server or the clamav-users mailing list if you’d like another avenue for asking ClamAV-related questions.
• Set up an environment for analyzing malware / network traffic
  • TODO Link to a knowledge base article about this

Choose a Project

• Browse the projects listed in the GitHub repo issuer tracker
• If you find one that isn’t marked ‘In Progress’ already, comment that you’d like to work on it.
  • TODO Document a template to use, that asks for initial estimate, looking for partners, other things?
• If you don’t see one available or that you’re interested in, but you have an idea for a project, create your own issue
  • TODO Point to a slack channel that can be used for vetting ideas

Work Your Magic (Analyze Malware / Write Coverage)

• TODO Point to the knowledge base, which contains useful information

Have Your Work Reviewed

• TODO This should be documented in the knowledge base, so link to there

Give Yourself Credit

• Submit a pull request to this repo adding your name and accomplishment to the Hall of Fame
  • TODO Document template to use