Skip to content

Contributing to IBMStreams

natashadsilva edited this page Sep 10, 2020 · 8 revisions

I'd like to propose a new toolkit

The process is outlined process.md in the toolkit repository. In short, propose your toolkit in in an issue in the toolkit repository. Try to give enough information to evaluate the proposed toolkit. The discussion will happen there.

I'd like to contribute to an existing toolkit

The best way to get started is to fork the the toolkit and make changes in your fork. When you're happy with the changes, issue a pull request to the IBMStreams repository. If you're doing work beyond a simple bug fix, it's recommended that you discuss your proposed changes in an issue first. The writers of the toolkit might have a plan to cover your desired functionality in a different way already.

I'd like to edit a wiki page

Go ahead! If it's a change that you think requires discussion, please create an issue and link to the wiki page. If someone used "there" instead of "their", just fix it.

I have a sample I want to share

Small sample applications go to the samples repository. If you have a small sample to contribute, the Streams samples repository has instructions. If you are not sure whether your application should go into samples or not, open an issue in the administration repository.

I have a utility that isn't a toolkit

Streams-related utilities are being collected in the streamsx.utilities repository. If you have a utility to contribute, open a(streamsx.utilities issue) to propose it.