├── .gitignore ├── IBMStreams-cla-individual.pdf ├── LICENSE.md ├── README.md ├── TEMPLATE_GRADUATION_STATUS.md ├── contribute.md ├── process.md └── welcome.md /.gitignore: -------------------------------------------------------------------------------- 1 | # streams-specific excludes 2 | toolkit.xml 3 | impl/nl/include/*.h 4 | output 5 | 6 | # These files are generated for C++ primative operators 7 | # If you want to include a perl module, after this line, do 8 | # !foo.pm 9 | *.pm 10 | 11 | 12 | # exclude generated Java primitive operator model files 13 | *$StreamsModel.java 14 | 15 | ## java excludes 16 | *.class 17 | 18 | # Package Files # 19 | # comment out the following line if you put pre-compiled packages into lib 20 | lib/*.jar 21 | impl/lib/*.jar 22 | *.war 23 | *.ear 24 | 25 | ## C++ excludes 26 | # Compiled Object files 27 | *.slo 28 | *.lo 29 | *.o 30 | 31 | # Compiled Dynamic libraries 32 | *.so 33 | *.dylib 34 | 35 | # Compiled Static libraries 36 | *.lai 37 | *.la 38 | *.a 39 | 40 | -------------------------------------------------------------------------------- /IBMStreams-cla-individual.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IBMStreams/administration/631db3f64d89c5db6cefa633d60b2fb9168f3707/IBMStreams-cla-individual.pdf -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ##License 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); you may not use this except in compliance with the License. 4 | 5 | You may obtain a copy of the License at 6 | 7 | [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0 "http://www.apache.org/licenses/LICENSE-2.0") 8 | 9 | Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | 11 | See the License for the specific language governing permissions and limitations under the License. 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## README -- IBMStreams/administration 2 | 3 | The IBMStreams toolkits project is an open source umbrella project focused on the development of projects within the IBMStreams organization. 4 | resources for IBM Streams. This currently includes toolkits, samples, tutorials and utilities. 5 | 6 | Use this repository to open enhancement issues for new proposals for repositories such as a new toolkit. If you have a proposal or idea for a new utility or sample, or a new operator in an existing toolkit project, open an issue in the corresponding repository. 7 | 8 | Refer to the [contribute.md](contribute.md) file for details on how to get involved with this project. 9 | 10 | Refer to the [process.md](process.md) file for a description of the processes used by the projects with the IBMStreams organization. 11 | Refer to the project's wiki for more information. 12 | � 13 | -------------------------------------------------------------------------------- /TEMPLATE_GRADUATION_STATUS.md: -------------------------------------------------------------------------------- 1 | # streamsx.XXXXX Graduation Status 2 | 3 | 4 | ## Overview 5 | Incubation for projects is covered here: https://github.com/IBMStreams/administration/wiki/Project-Incubation-Process 6 | 7 | ## Status 8 | 9 | - [ ] :red_circle: Stable release(s) 10 | * Status: **TBD** 11 | - [ ] :red_circle: Project is properly documented 12 | * Status: **TBD** 13 | - [ ] :red_circle: Project has samples and instructions to help users get started easily 14 | * Status: **TBD** 15 | - [ ] :red_circle: Sufficient testing 16 | * Status: **TBD** 17 | - [ ] :red_circle: Instructions on how to get started with development and contributing to project 18 | * Status: **TBD** 19 | - [ ] :red_circle: Website that contains information and documentation of the project 20 | * Status: **TBD** 21 | - [ ] :red_circle: Clear release plan 22 | * Status: **TBD** 23 | - [ ] :red_circle: At least one active committer 24 | * Status: **TBD** 25 | 26 | ### Key 27 | * :white_check_mark: - Complete 28 | * :large_orange_diamond: - Partially complete 29 | * :red_circle: - Not complete/started or unknown 30 | 31 | ## Instructions 32 | A project should have this file copied to `GRADUATION_STATUS.md` at the top-level. 33 | 34 | Projects self-report their status though IBMStreams admins may override any status. 35 | -------------------------------------------------------------------------------- /contribute.md: -------------------------------------------------------------------------------- 1 | # Contributing to IBMStreams projects 2 | 3 | All contributions are welcome. Contributors are expected to conduct themselves in a professional and courteous manner. If you want to contribute code you will be required to sign an individual contributor agreement found here: [IBMStreams-cla-individual.pdf](IBMStreams-cla-individual.pdf) 4 | 5 | Issues: all projects will use the github Issues for issue tracking. 6 | 7 | Code: contained with the projects. 8 | 9 | Wiki: used to communicate and discuss designs, changes, plans etc.. 10 | 11 | Process: refer to process.md document 12 | 13 | Proposals: refer to the process.md document 14 | 15 | [IBM Streams Quick Start Edition (No Charge for non-production use)](https://ibm.co/streamsqs) 16 | -------------------------------------------------------------------------------- /process.md: -------------------------------------------------------------------------------- 1 | # IBMStreams Process 2 | 3 | The IBMStreams organization within www.github.org is an IBM initiated open source organization focused on extending the programming resources for IBM InfoSphere Streams product. We actively encourage anyone interested in IBM InfoSphere Streams to participate and contribute to the projects within this organization. 4 | 5 | ## Managing Committee 6 | 7 | The IBMStreams organization has a managing committee that oversees the projects operating within the IBMStreams organization. This committee is made up of persons with a vested interest in the success of IBMStreams. The committee responsibilities include, managing committer rights, managing the projects, managing the proposals process and generally ensuring that the project is well run and that contributors are able to function in a productive manner. 8 | 9 | ## Proposals 10 | 11 | We are seeking proposals for new toolkits or operators for IBM InfoSphere Streams. The process for a new proposal is: 12 | 13 | 1. Open a new Issue in the IBMStreams/administration repository. Give it a meaningful title and describe the proposal in the issue. 14 | 2. The proposal will be discussed by commenting on the issue. 15 | 3. Once the proposal has been discussed, there will be a vote by IBMStreams/adminstration managing committee recorded in the proposal Issue. 16 | 4. Outcomes are: 17 | a) proposal accepted, new repository created and project started. 18 | b) proposal accepted, work assigned to an existing project. 19 | c) proposal rejected. Proposals will be accepted for IBMStreams if they are of value to a broad audience in the IBMStreams community. Some projects may be recommended for incubation outside the IBMStreams community. 20 | 21 | ## Committers 22 | 23 | The IBMStreams organization will create an initial set of committers when a repository/project is created. Each repository will have a team created called *reponame*Committers and these people will have write access to the repository. To become a committer the process is: 24 | 25 | 1. Establish a good track record of contributions and have a signed individual contributor agreement in place. 26 | 2. Be nominated by an existing committer via an Issue titled: Commiter Nomination: *persons name* *@githubid* 27 | 3. Existing committers will then vote in the Issue and 2/3 positive votes are required to be a committer 28 | 4. IBMStreams management committee reserves the right to revoke committer status for individuals that are deemed to not be acting in the best interests of the project. 29 | 30 | ## Process 31 | 32 | 1. Issues will be tracked using github issues. 33 | 2. The project github wiki will be used for communication of ideas, designs, meeting minutes, schedules etc... 34 | 35 | #### Branches 36 | 37 | Main branch will be called master and is considered to be deployable. This branch is expected to work and anything pushed to that branch is consider to work. Care will be taken to ensure that this branch is always stable, works and new work can be branched from it. 38 | 39 | Feature or work branches should be created from the main branch and given a meaningful title. As work proceeds in these branches changes should be regularly pushed to the server in order for people to see the progress as it is being made. Once a feature/work branch is ready to merge with the master branch a pull request should be created and the project committer(s) will review the changes and update the main branch. 40 | 41 | ## Development Environment 42 | 43 | You can download the IBM InfoSphere Streams Quick Start Edition which has no charge for non-production use from here: [http://www-01.ibm.com/software/data/infosphere/streams/quick-start/downloads.html](http://www-01.ibm.com/software/data/infosphere/streams/quick-start/downloads.html) 44 | 45 | For more information on getting started with Streams go to [http://ibm.co/streamsdev](http://ibm.co/streamsdev) 46 | 47 | 48 | -------------------------------------------------------------------------------- /welcome.md: -------------------------------------------------------------------------------- 1 | Information to help new project get started. 2 | 3 | # Welcome to IBMStreams 4 | 5 | As a new project, here are a few resources to help you get started: 6 | 7 | 1. To add content, refer to the [IBM Streams repository guidelines](https://github.com/IBMStreams/administration/wiki/IBMStreams-repository-guidelines) 8 | 2. To create a website, refer to the page: [Creating a web page for your toolkit](https://github.com/IBMStreams/administration/wiki/Creating-a-web-page-for-your-toolkit) 9 | 3. Understand the project [incubation process](https://github.com/IBMStreams/administration/wiki/Project-Incubation-Process). 10 | 4. Before a release, understand the suggested [versioning guildelines](https://github.com/IBMStreams/administration/wiki/Toolkit-Versions) and [release process](https://github.com/IBMStreams/administration/wiki/On-Demand-Release-Process). 11 | --------------------------------------------------------------------------------