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

Feature/add description field to meeting model #135

Merged
merged 11 commits into from
Apr 19, 2024

Conversation

timDeHof
Copy link
Contributor

Description

This PR adds an optional description field to the meeting model schema, which allows users to provide a detailed description of the meeting. This improves the information available for each team meeting and provides more context for participants.

Issue link

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature updates / changes
  • Tests
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • migrate the databases and seed it
  • run unit and e2e tests
  • check in swagger UI that the creating meetings endpoint shows a description field in the response.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have updated the change log

…ting model

The 'TeamMeeting' model now includes an optional 'description' field. This change allows for additional information to be provided about the team meeting, if necessary.
The migration.sql file adds a new column "description" of type TEXT to the "TeamMeeting" table. This allows for an optional description field to be associated with each meeting in the model. This change enhances the flexibility and usability of the meeting model by providing a way to include additional information about each meeting.
…ontext

The meeting seed data now includes a description field to provide more information and context about each meeting. This improves the overall quality of the seed data and makes it more useful for testing and development purposes.
…se and MeetingResponseWithSprintAndAgenda classes for better representation of meeting descriptions

The MeetingResponse and MeetingResponseWithSprintAndAgenda classes now have a description property. This allows for a more comprehensive representation of meeting objects by including a detailed description of the meeting.
…TeamMeeting and updateTeamMeeting methods

The createTeamMeeting and updateTeamMeeting methods in the SprintsService now support the description field in the CreateTeamMeetingDto and UpdateTeamMeetingDto respectively. This allows users to provide a description for team meetings, providing more context and information about the meeting.
…MeetingDto for better meeting information

The CreateTeamMeetingDto now includes a description field, which allows users to provide a detailed description of the meeting. This improves the information available for each team meeting and provides more context for participants.
…n e2e tests

The e2e tests for the Sprints Controller now include a description field in the sprint objects. This change ensures that the description field is properly tested and validated in the controller's endpoints.
@timDeHof timDeHof self-assigned this Apr 16, 2024
The meeting model schema has been updated to include an optional description field. This change was made in PR #135.
@timDeHof timDeHof marked this pull request as ready for review April 17, 2024 01:03
@cherylli
Copy link
Contributor

Everything else works fine, all tests passed

cherylli and others added 2 commits April 17, 2024 13:58
… description property in CreateTeamMeetingDto

The @IsOptional() decorator is added to the description property in the CreateTeamMeetingDto class. This change allows the description property to be optional when creating a team meeting.
@timDeHof timDeHof requested a review from cherylli April 17, 2024 13:13
@timDeHof
Copy link
Contributor Author

I have added IsOptional() to the dto

Copy link
Contributor

@cherylli cherylli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect. Thanks!

@cherylli
Copy link
Contributor

@JoshuaHinman @curtwl

Copy link
Contributor

@JoshuaHinman JoshuaHinman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E2e tests passed, swagger example looks good. I had to go up to sprint 4 to create a meeting without a conflict, but it works as described - nice work!

@timDeHof timDeHof merged commit 3b5272d into dev Apr 19, 2024
1 check passed
@timDeHof timDeHof deleted the feature/add-description-to-meeting-model branch April 19, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants