Skip to content

Commit

Permalink
[1904] Provide a template for shapes and scopes
Browse files Browse the repository at this point in the history
Bug: #1904
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
  • Loading branch information
sbegaudeau committed Apr 6, 2023
1 parent ddc4da4 commit 87e4550
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/doc @sbegaudeau
/frontend @sbegaudeau
/packages/charts @AxelRICHARD
/packages/compatibility @pcdavid
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,12 @@ This has no visible effect at the moment, but will allow better documentation, v
- https://github.com/eclipse-sirius/sirius-components/issues/1879[#1879] [core] Add an annotation `@Builder` to identify builders and simplify some use cases involving the builder pattern.
It is now possible to use builders in records and it is a first step toward the deprecation of the `@Immutable` annotation in favor of more records.
- [diagram] Added a common interface `IDiagramElement` that is implemented by `Node` and `Edge`
- https://github.com/eclipse-sirius/sirius-components/issues/1904[#1904] [project] Add templates to track our work on shapes and scopes.
At the end of every iteration, we will work on the shape of the new iterations and validate them by merging a first version.
+
During the iteration, while developers will progress on their work, they will update the scope.
We will not create a new commit for each minor change in the scope, instead the scope will evolve while a pull request is updated.
The progress on a task could thus be shared with a draft pull request with the rest of the team.


== v2023.3.0
Expand Down
22 changes: 22 additions & 0 deletions doc/iterations/YYYY-MM/scopes/scope.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= Scope

== First task

- [x] Shape written, reviewed and merged
- [x] ADR written, reviewed and merged
- [x] Mock of the features done with Figma
- [x] First prototype of the user interface
- [ ] First version of the user interface done with Cypress tests
- [ ] Capture proper screenshots for the CHANGELOG and the documentation

== Second task

- [x] First prototype of the GraphQL API and implementation
- [x] Improvement of the first prototype after the discovery of performance issues
- [ ] Second prototype of the backend merged


== Third task

- [ ] User guide updated with screenshots
- [ ] Integrated tests updated
46 changes: 46 additions & 0 deletions doc/iterations/YYYY-MM/shapes/shape.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
= (appetite) Shape

== Problem

Short description of the problem.

== Key Result

How we will determine whether the problem has being solved.
Qualitative and quantitative measures.

== Solution

Describe the solution.
The core elements we came up with, presented in a form that’s easy for people to immediately understand.

Solution must define:

=== Scenario

The user scenario covered by the feature. It should define:

* User
* Scenario name
* What we want to show
* Scenario steps
* Features

=== Breadboarding

UI description made by hand

=== Cutting backs

Sort the things todo, define the nice-to-have. What could be removed if finally the feature does not fit the appetite.

== Rabbit holes

Details about the solution worth calling out to avoid problems.
Try to identify the most risky areas which can trip up our assumptions.
Look critically at what we came up with. Did we miss anything?
Are we making technical assumptions that aren't fair?

== No-gos

List the things which are explicitly out of scope, where we should not spent time.

0 comments on commit 87e4550

Please sign in to comment.