Skip to content

Commit

Permalink
Merge pull request eclipse-tractusx#10 from eclipse-tractusx/chore/ge…
Browse files Browse the repository at this point in the history
…neral_issue_templates

(chore): add issues templates
  • Loading branch information
danielmiehle authored Jul 12, 2023
2 parents 7bb0bf8 + 627d261 commit 995a737
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Report a Bug
about: report bugs or unexpected behavior.
---

<!--
Thanks for your contribution! Please fill out this template as good as possible.
Important: Contributing Guidelines can be found here: https://eclipse-tractusx.github.io/docs/oss/how-to-contribute
Checkout the repository README for process description.
-->

## Description
<!-- A clear and concise description of what the bug is. -->

## Expected behavior
<!-- A clear and concise description of what you expected to happen. -->

## How to reproduce
<!-- Please provide a clear procedure how to reproduce the bug.
Important technical details:
browser, app-version, environment, device, etc.
-->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Propose a Feature
about: propose a new functionality
---

## Description
<!--
A clear and concise description of what the desired feature will look like.
What is the purpose, what´s the expected result.
Please describe.
-->

## Impact
<!--
If possible, please provide insight in what and how many components might be affected or give a hint, if the feature implementation might result in breaking changes.
-->

## Additional information

- [ ] I'm willing to contribute this feature to the community



65 changes: 63 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,64 @@
# SIG-Project-Management
# SIG-Release

This repository contains all project management related information.
Welcome to SIG-Release, home of release and feature management.

## The planning and roadmap process

We follow a coordinated approach to plan improvements of Eclipse Tractus-X.

While every repository in the [eclipse-tractusx](https://github.com/eclipse-tractusx) GitHub organization
has its own issue management, the [release planning board](https://github.com/orgs/eclipse-tractusx/projects/26)
is used to align the overarching Tractus-X releases.

### How can I get involved

In case you experienced a bug, unexpected behaviour, or you want to propose enhancements to Eclipse Tractus-X,
feel free to use on of the provided [issue templates](https://github.com/eclipse-tractusx/sig-project-management/issues/new/choose) and describe your request.
Please be aware, that not every feature request can be integrated and that we also cannot treat every issue with highest priority.

Every Release planning will be kicked off by two public alignment sessions. The dates and further details will be shared via
[tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list.
Issues or bug reports, that should be discussed in these meetings, have to be opened prior to the meeting via
our [issue templates](https://github.com/eclipse-tractusx/sig-project-management/issues/new/choose).

### Issue structure

Our issues do have important properties, that enable our planning process. These are:

- __Labels:__ We use them to indicate the involved teams. A label for each involved component is added to an issue
- __Issue Type:__ To separate between bugs and feature request, we use a custom field `Issue Type`
- __Milestone:__ Every Tractus-X release is represented by a `Milestone`. You can use this field to get a rough idea about the ETA
- __Status:__ The status field is used to integrate the progress of an issue
- __Iteration:__ `Milestone`s are divided in multiple iterations. The 'Iteration' field is used to do finegrained timeline planning

### Issue statuses

The following statuses are defined:

- __Planning:__ This is the initial status of all issues. It indicates, that involved components have to be identified and additional information gathered
- __Backlog:__ If enough information is gathered and we agreed to work on the issue, it is set from `Planning` to `Backlog` to indicate it is ready for timeline planning
- __Work in Progress:__ The issue is actively been worked on.
- __Done:__ All relevant parts have been implemented and released

### Issue process

Every new feature proposal or bug report will be handled as issue in status `Planning` initially. The alignment meetings are used to discuss the purpose and impact of the current issues.
While in `Planning` status, the involved components are discovered and respective `Labels` are added. If already possible, a desired `Milestone` can be set.
Additionally an `Assignee` is selected, who will coordinate efforts to solve the issue.

After these details are clarified, an issue is moved to `Backlog` to open it for detailed timeline planning. In this status, discussions about a fitting `Iteration` is held.

As soon as actual work is started in the selecte iteration, the issue is set to `Work in Progress`. This is especially helpful on our project milestone views to get an overview of the release progress.

The final status `Done` is set, as soon as all relevant implementations are done, tested and released. This has to be achieved for every change in every involved component.

### Planning component changes

While the [Release Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26) is used to coordinate overarching feature and bug request,
we encourage every component team to break these issues down to their component repositories/projects.
When doing so, make sure you link to the overarching issue in your component issue description.


## Contact

- [Mailing List](https://accounts.eclipse.org/mailing-list/tractusx-dev)

0 comments on commit 995a737

Please sign in to comment.