-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing to Storm
To contribute to Storm, you will need to sign a contributor agreement. This is a standard agreement used by most major open source projects to provide legal protection to the project and community. Basically you just agree to share ownership of the code with the project.
You can download the contributor agreement here. The easiest way to fill it out is with HelloFax, where you can fill in the fields, sign it, and email it back all digitally. The whole process should only take a couple minutes. Email the filled and signed agreement to [email protected].
Make sure you fill in all the fields. These are:
- Username for Storm
- Username for storm-contrib (should be same as above)
- Name
- Company's name
- Mailing address
- Telephone and email
- Signature
- Date
Some of the issues on the issue tracker are marked with the "Newbie" label. If you're interesting in contributing to Storm but don't know where to begin, these are good issues to start with. These issues aren't anticipated to be a lot of work, require learning about only an isolated portion of the codebase, and are a great way to get your feet wet with learning the codebase.
Contributions to the Storm codebase should be sent as GitHub pull requests. If there's any problems to the pull request we can iterate on it using GitHub's commenting features.
Modules built on top of Storm (like spouts, bolts, etc) that aren't appropriate for Storm core can be done as your own project or as part of storm-contrib. To be part of storm-contrib just send an email to the mailing list proposing to add your module to storm-contrib. Then you'll be added as a committer to storm-contrib and can maintain your project there. The advantage of hosting your module in storm-contrib is that it will be easier for potential users to find your project.
Documentation contributions are very welcome! The best way to send contributions is as emails through the mailing list.