Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3653] Add documentation for Gantt #3654

Merged
merged 1 commit into from
Jun 20, 2024
Merged

[3653] Add documentation for Gantt #3654

merged 1 commit into from
Jun 20, 2024

Conversation

lfasani
Copy link
Contributor

@lfasani lfasani commented Jun 20, 2024

Bug: #3653

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?

@lfasani lfasani added this to the 2024.7.0 milestone Jun 20, 2024
@lfasani lfasani self-assigned this Jun 20, 2024
@lfasani lfasani requested a review from sbegaudeau as a code owner June 20, 2024 07:58
@lfasani lfasani linked an issue Jun 20, 2024 that may be closed by this pull request
1 task
doc/specifier/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/specifier/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/specifier/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/specifier/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/specifier/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/user/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/user/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/user/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/user/representation-gantt.adoc Outdated Show resolved Hide resolved
doc/user/representation-gantt.adoc Outdated Show resolved Hide resolved
@lfasani lfasani force-pushed the lfa/enh/ganttdoc branch from 5c96df5 to 0acc87c Compare June 20, 2024 12:19
@lfasani lfasani requested a review from frouene June 20, 2024 12:20
Bug: #3653
Signed-off-by: Laurent Fasani <[email protected]>
Signed-off-by: Florian ROUËNÉ <[email protected]>
@frouene frouene force-pushed the lfa/enh/ganttdoc branch from 0acc87c to 8138cc0 Compare June 20, 2024 12:37
@frouene frouene merged commit 11e5b3b into master Jun 20, 2024
3 checks passed
@frouene frouene deleted the lfa/enh/ganttdoc branch June 20, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for Gantt
2 participants