Context

In Nov 2022 the StreamPipes community decided to switch from JIRA
to GitHub issues when it comes to manage and communicate all kind of tasks.
Consequently, if you would like to create an issue/task go to StreamPipes' issue page on GitHub.

How to create an issue?

1) Start at the GitHub issue page

2) Click on new issue.   

3) Select one of the provided templates (please select the fast track only if you are already a StreamPipes committer and familiar with our issue management)

4) Fill out the issue form


How to add subtasks to an issue?

You can extend an issue with subtasks by adding a Subtasks  heading followed by a checkbox list with the actual subtasks.
From each entry you can directly create a subtask by clicking on the icon on the right handside.

How to work with labels?

When viewing an issue in the detail view (just click on it), you can assign labels via the menu on the right side.
All labels with description can be found here.
You can assign as many labels as you want but please select only appropriate labels since we plan to use them for generating our release notes.
Issues created via our issue templates have some labels per default, but further labels can be added of course (this applies only for committers). 


How to add a (planned) release version?

Within GitHub we plan our releases using so called "milestones".
We create a milestone for each release or introduce artificial releases (e.g., post-1.0 ) to just somehow group our issues.
Please try to assign every issue to a milestone so that we do not end up with a lot of zombie issues (this applies only for committers). 

You can get an overview of all milestones and their degree of completion here.

How to link issues and PRs?

1) When you stark working on an issue

Ideally, you start working on an issue by creating the corresponding branch.
This can be done directly within the detail view of an issue via the Development section of the right menu bar.
When you use the default branch name proposed by GitHub, all commits and the resulting PR are automatically linked to the issue.

2) When you want to link an existing PR

In case there is an existing PR that is not yet linked with an existing issue but there is already one that is related (there is no need for having an issue for every PR),
you can link the PR on the issues' default page.
Simply select the correct repository (sometimes you don't need to) in the Development  section on the right menu bar and search for the related issue number, click apply to save the changes.



  • No labels