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: Update readme doc for i18nify repo: [ATLAS-65] #19

Merged
merged 6 commits into from
Nov 28, 2023

Conversation

RgnDunes
Copy link
Collaborator

Description

This PR adds a README file to the repo with proper documentations.

Changes Made

List the main changes made in this pull request.

Title ---
JIRA link https://razorpay.atlassian.net/browse/ATLAS-65
Slack thread (if any) NA
Product spec NA
Tech spec/One-pager NA
Bundle Size Difference 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

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.

@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3467ef0) 83.16% compared to head (eb4bdf9) 83.16%.
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #19   +/-   ##
=======================================
  Coverage   83.16%   83.16%           
=======================================
  Files          13       13           
  Lines         101      101           
  Branches       28       28           
=======================================
  Hits           84       84           
  Misses         17       17           

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

@rzpcibot
Copy link
Contributor

rzpcibot commented Nov 22, 2023

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 13.01 13.01 $\textcolor{green}{0}$ 0
🟢 esm/index.js 12.99 12.99 $\textcolor{green}{0}$ 0
🟢 umd/index.js 14.53 14.53 $\textcolor{green}{0}$ 0

Generated by 🚫 dangerJS against eb4bdf9

@RgnDunes RgnDunes marked this pull request as draft November 22, 2023 09:34
@RgnDunes RgnDunes marked this pull request as ready for review November 28, 2023 14:49
@RgnDunes RgnDunes merged commit 6a48fb4 into master Nov 28, 2023
7 of 8 checks passed
@RgnDunes RgnDunes deleted the ATLAS-65-update-readme-doc-for-i-18-nify-repo branch November 28, 2023 20:26
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.

4 participants