Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 5.72 KB

open-refinement-and-planning.md

File metadata and controls

110 lines (72 loc) · 5.72 KB
Raw

Welcome to our guide on the open refinement and planning processes for our open source community. Effective planning and transparent communication are critical for the success of our project. Here, we'll outline how our community can participate and leverage these processes to ensure smooth and efficient collaboration.

Overview

Open refinement and planning allow the community to:

  1. Discuss - Exchange thoughts, feedback, and suggestions on potential new features.
  2. Refine - Hone and polish ideas into actionable items.
  3. Prioritize - Decide on the features that should be worked upon in the upcoming releases.

Refinement

  • Related UserStories/Tasks will be created within product repository (task breakdown)
  • Link the related UserStories/Tasks/Issues to the feature
  • Set appropriate state ("Input" or "Backlog")

During Planning

  • The Release Planning Board will be used: Release Planning / Release View
  • Finally, attach all related UserStories/Tasks/Issues that have been planned for that feature
  • Set the target Release milestone

How to plan and track features sig-release

  1. Issue Creation: Anyone in the community can suggest a new feature by creating an issue in the sig-release repository.
  2. Issue Type: When creating your issue, it's crucial to specify the Issue Type:
    • feature: For new open features.
    • bug: For bugs or issues with existing features.
  3. Labels: Use relevant labels to further categorize and provide context to your feature (in any case, please also select your specific product label).
  4. Milestone: Use relevant milestone for the next release, if you already know, it will be implemented. Officially, the milestone is set during the planning meeting.

Good to know: Use the Release Planning / Inbox board to add new open features. There is the last row with the functionality to add new issues.

Task lists on Feature Level in sig-releases

When creating a feature, it's recommended to use a task list to break down the feature into smaller, actionable tasks. This not only provides clarity but also allows collaborators to pick up specific tasks and also link the different tasks to the related product repositories.

BUT: These tasks should be created in the related product repository and should be linked / mentioned to the feature in sig-release repository.

## Tasks for Feature XYZ:

- [ ] Task 1 description.
- [ ] Task 2 description.
- [ ] Task 3 description.

Linking Issues from Different Repositories

Important: Please don`t use the "create issue" functionality from GitHub (provided with a task list). This will create a new issue in the "sig-release" repository. Moving this ( to the specific product repository ) and all the links is a mess. Please create the issue in the related product repository and link it to the feature in the "sig-release" repository. see also Linking Issues from Different Repositories

To reference issues from different repositories within your task list, follow these steps:

  1. Ensure you have the full path: owner/repo#issue_number. For instance, eclipse-tractusx/item-relationship-service#187.
  2. Embed this in your markdown as you would any other link or mention.

Example:

Feature PCWM Transfer. Two Issues from different repositories are linked to this feature.

### Related Issues:

- [ ] eclipse-tractusx/item-relationship-service#187
- [ ] eclipse-tractusx/item-relationship-service#188

Boards

We utilize several boards to manage and track the progress of issues and features:

  1. Release Planning / Inbox: Used for adding new open features.
  2. Release Planning / Bug Board: Tracks ongoing work on bugs.
  3. Release Planning / Release 23.12 View: Tracks ongoing work on all features for the next release.

General guidelines

while (Eclipse Tractus-X Activity) {
    beNice_to_all();
    communicate();
    value(code).over(hierarchy);
    act(responsibly);
    have(greatTime);}

Community Participation

We encourage all community members to participate actively in the open refinement and planning processes. Together, we can ensure that the project continually evolves and improves to meet the needs and expectations of its users.

Please see also more information related to sig-release repository and planning.

Follow our news section and join our Tractus-X mailing list and be part of our Matrix Chat from Eclipse Tractus-X.

In case of any questions, please create a discussion in the sig-release repository.

Feedback

We welcome feedback and suggestions on how we can improve our open refinement and planning processes. Please create a discussion in the sig-release repository.

NOTICE

This work is licensed under the Apache-2.0.