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

docs[ATLAS-104]: Adding Documentation for Date & Time Module #56

Conversation

RgnDunes
Copy link
Collaborator

@RgnDunes RgnDunes commented Jan 18, 2024

Description

This PR adds documentation for Date & Time Module for below api's:

  • add
  • substract
  • formatDate
  • formatDateTime
  • formatTime
  • getFirstDayOfWeek
  • getQuarter
  • getRelativeTime
  • getWeek
  • getWeekdays
  • isAfter
  • isBefore
  • isLeapYear
  • isSameDay
  • isValidDate
  • parseDateTime

Changes Made

List the main changes made in this pull request.

Title ---
JIRA link https://razorpay.atlassian.net/browse/ATLAS-104
Slack thread (if any) NA
Product spec Date Module - i18nify , Date & Time Usage in Merchant Dashboard
Tech spec/One-pager NA
Bundle Size Difference NA
Fixes Issue NA

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • 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
  • This change is a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Is your change backward compatible ?
  • Tested on major browsers (Chrome, Firefox, Safari, IE) ?
  • Tested in a consumer application(s) ?

Additional Notes

Any additional information that would be helpful for the reviewer.

Checklist:

  • Add Jira ID(s) in PR title and in the description?
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My code is written in TypeScript and follows the coding standards of the project.
  • I have added relevant documentation and updated the README if necessary.
  • My commit messages are clear and follow the project's commit message conventions.
  • Is any external library added?
  • My changes do not introduce any new runtime errors or warnings.
  • All relevant unit tests have been added/updated in my PR for the change.
  • Any Screenshots (mobile & desktop) required for PR? If yes, have you added the respective screenshots ?
  • Any manual dev testing done by you on beta/func environment?
  • Reviewer added (SLA 2 days)

Reviewer Checklist

  • Sufficient QA/Dev-Testing is done with proof (test cases list)
  • Ensure that the change in bundle size falls within the acceptable range.

PR Title Format

Format: <type>: <subject>

Types can be as follows:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Copy link

changeset-bot bot commented Jan 18, 2024

⚠️ No Changeset found

Latest commit: 66c3c18

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@RgnDunes RgnDunes marked this pull request as draft January 18, 2024 19:59
@rzpcibot
Copy link
Contributor

rzpcibot commented Jan 18, 2024

Bundle Size Report

Files

click to expand/collapse
🟢 No Change 🗑 File Deleted 🆕 New File 📈 Size Increased 👍 Size Reduced
Parsed (kb)
🚦 File Name Base PR Diff %
🟢 cjs/index.js 56.74 56.74 $\textcolor{green}{0}$ 0
🟢 esm/index.js 56.6 56.6 $\textcolor{green}{0}$ 0
🟢 umd/index.js 63.46 63.46 $\textcolor{green}{0}$ 0

Generated by 🚫 dangerJS against 3944346

@codecov-commenter
Copy link

codecov-commenter commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (727a19f) 41.41% compared to head (66c3c18) 41.41%.

Additional details and impacted files
@@                             Coverage Diff                              @@
##           ATLAS-104-date-module-and-ap-is-development      #56   +/-   ##
============================================================================
  Coverage                                        41.41%   41.41%           
============================================================================
  Files                                               49       49           
  Lines                                              594      594           
  Branches                                           163      163           
============================================================================
  Hits                                               246      246           
  Misses                                             342      342           
  Partials                                             6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This comment has been minimized.

@RgnDunes RgnDunes changed the base branch from master to ATLAS-104-date-module-and-ap-is-development January 23, 2024 06:57

This comment has been minimized.

@RgnDunes RgnDunes changed the base branch from ATLAS-104-date-module-and-ap-is-development to master January 23, 2024 06:58
@RgnDunes RgnDunes changed the base branch from master to ATLAS-104-date-module-and-ap-is-development January 23, 2024 06:58
…development' into ATLAS-104-date-module-and-apis-development-readme-update

This comment has been minimized.

This comment has been minimized.

@RgnDunes RgnDunes marked this pull request as ready for review January 23, 2024 09:06
…development' into ATLAS-104-date-module-and-apis-development-readme-update

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

…S�¤@ # àìٖ�Ë�§��MÇW<7å!`¡����o�åËÜQOöà&¾�ü7¸&tQ٫ÀB�c�F\�#�U��»l��Ý3¹:¼ �s��;#Åt%3©teEåËÍaƆ�%Ǵ�þO�_X_)�¡^�º�Q¸9ñ|(¬VÚÀ/ⱌ/ûÛÛÍÛ"��$÷�Q G,S��¢\,νk8	{7�#òÃq��¹²&é'<���µ»q®ïúï{¥àbGgØ|Å;B���F2��¥hl,ÓæBր¢�«pµá-p$p'NÆtc¥GÏb¤+��3��#/IÏR�)c³��ÁÎ÷�þí܏Gq�F¥�Fóâl|Ec!��X�j¢óHÙxZ�ÊÃ�ÝÁ����©¾¾£¿�.��ÓU�¶¾¡%ýî[�

y� �Í8Ý\ï�¹�¢;�R¹�Q

This comment has been minimized.

This comment has been minimized.

@RgnDunes RgnDunes marked this pull request as draft February 8, 2024 09:07

This comment has been minimized.

…development' into ATLAS-104-date-module-and-apis-development-readme-update
Copy link
Contributor

Unit Test Results

0 files  ±0  0 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 66c3c18. ± Comparison against base commit 727a19f.

@RgnDunes RgnDunes marked this pull request as ready for review February 14, 2024 07:31
@RgnDunes RgnDunes merged commit 140f42e into ATLAS-104-date-module-and-ap-is-development Feb 14, 2024
7 checks passed
@RgnDunes RgnDunes deleted the ATLAS-104-date-module-and-apis-development-readme-update branch February 14, 2024 10:08
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