Unit tests and Integration tests are an essential part of code contributions. Implement your issue, create a pull request (see below), and iterate from there.Storm committers will iterate with you on the design to make sure you are on the right track.Going to touch and how everything is going to fit together. Explain what pieces of the codebase you are Comment on the issue with your plan for implementing the issue.If a similar issue does exist, then you may consider participating in the work on the existing Open an issue on our issue tracker if a similar issue does notĮxist already.Wasted work and catch design issues early on. The idea behind this process is to prevent any If there is any problem with the pull request we can iterate on it using the commenting features ofįor small patches, feel free to submit pull requests directly for those patches.įor larger code contributions, please use the following process. See section Create a pull request belowįor details. As of this writing, the Storm codebase would benefit fromĬontributions to the Storm codebase should be sent as GitHub pull requests. Perhaps the most important is consistenly writing a clear docstringįor functions, explaining the return value and arguments. Please use idiomatic Clojure style, as explained in this Clojure style guide. You may want to start with beginner-friendly, easier issuesīecause they require learning about only an isolated portion of the codebase and are a relatively small amount of work. If you are interested in contributing code to Storm but do not know where to begin:īrowse our issue tracker for open issues and tasks. You can also opt to send a message to the Storm Users mailing list.īefore you set out to contribute code we recommend that you familiarize yourself with the Storm codebase, notably by Issue tracker before you will need to register an account (free), log in, and then click on the blue "Create Issue"
Set the form field "Issue type" to "New feature". To request a new feature you should open an issue in our issue trackerĪnd summarize the desired functionality.
You can also opt to attach a patch file to the issue ticket, but we prefer pull requests because they are easier to work That is great! In this case please send us a pull request as described in section Create a pull request below. If you want to provide a patch along with your bug report: Such a ticket please add your information as a comment. the Storm version you were using.įeel free to search the issue tracker for existing issues (aka tickets) that already describe the problem if there is In order to help us understand and fix the bug it would be great if you could provide us with: Need to register an account (free), log in, and then click on the blue "Create Issue" button in the top navigation bar. If you have not used the issue tracker before you will Set the form field "Issue type" to "Bug". To report a bug you should open an issue in our issue tracker that
This section explains how to perform common activities such as reporting a bug or merging a pull request. If you are reading this document then you are interested in contributing to the Storm project - many thanks for that!Īll contributions are welcome: ideas, documentation, code, patches, bug reports, feature requests, etc.
This document summarizes information relevant to Storm committers and contributors.