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

Main #4340

Merged
merged 10 commits into from
Jun 25, 2024
Merged

Main #4340

merged 10 commits into from
Jun 25, 2024

Conversation

Meriem-BM
Copy link
Collaborator

@Meriem-BM Meriem-BM commented Jun 25, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced donation settings to support multiple chains, increasing the potential for receiving donations.
    • Added a new sponsor entry for "@PublicNouns" in the active projects banner.
  • Bug Fixes

    • Corrected a typo in the quadratic funding description.
  • Improvements

    • Updated donation address labels for clarity across multiple languages (English, Catalan, Spanish).
    • Improved number formatting for donations to be more readable.
    • Adjusted styling for sponsor display.
  • Version

    • Updated application version to 2.28.1.

Copy link

vercel bot commented Jun 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
giveth-dapps-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2024 4:45pm

Copy link
Contributor

coderabbitai bot commented Jun 25, 2024

Walkthrough

The recent updates focus on refining user interface text for clarity and functionality across multiple language files, enhancing Ethereum donation settings, modifying various project-related components for improved currency formatting, and upgrading the package.json version. Collectively, these changes enhance the ease of managing quadratic funding projects and accepting donations across multiple cryptocurrency chains.

Changes

File Path Change Summary
lang/ca.json, lang/en.json, lang/es.json Updated donation settings labels for clarity and added information about accepting funds across more chains.
package.json Updated the version from 2.28.0 to 2.28.1.
src/components/project-card/ProjectCard.tsx Removed unused functions and updated currency formatting logic in EstimatedMatchingPrice.
src/components/views/archivedQFRounds/ArchivedQFRoundsTable.tsx Added currency formatting (formatPrice) for displayed fund values.
src/components/views/donate/EstimatedMatchingToast.tsx Modified formatWithCurrency function, removed getEstimatedMatchingRange function.
src/components/views/project/projectActionCard/QFSection.tsx Replaced formatWithCurrency with formatDonation for simplified display logic.
src/components/views/projects/qfBanner/ActiveQFProjectsBanner.tsx Added a new sponsor entry for @publicNouns.
src/components/views/projects/qfBanner/common.ts Added new styling rules for sponsor elements.
src/helpers/number.ts Enhanced formatDonation to use localized strings for numbers.
src/helpers/qf.ts Commented out the getEstimatedMatchingRange function and related code.

Poem

In code we trust, our path is set,
To make donations easier yet.
Ethereum addresses tailored fine,
Across chains the funds will intertwine.
With sponsors new and banners bright,
Quadratic funding takes its flight.
🐇✨💰


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e918b11 and ff554bb.

Files ignored due to path filters (1)
  • public/images/banners/qf-round/publicNouns.svg is excluded by !**/*.svg
Files selected for processing (12)
  • lang/ca.json (1 hunks)
  • lang/en.json (2 hunks)
  • lang/es.json (1 hunks)
  • package.json (1 hunks)
  • src/components/project-card/ProjectCard.tsx (4 hunks)
  • src/components/views/archivedQFRounds/ArchivedQFRoundsTable.tsx (2 hunks)
  • src/components/views/donate/EstimatedMatchingToast.tsx (2 hunks)
  • src/components/views/project/projectActionCard/QFSection.tsx (3 hunks)
  • src/components/views/projects/qfBanner/ActiveQFProjectsBanner.tsx (1 hunks)
  • src/components/views/projects/qfBanner/common.ts (1 hunks)
  • src/helpers/number.ts (1 hunks)
  • src/helpers/qf.ts (2 hunks)
Files skipped from review due to trivial changes (4)
  • lang/ca.json
  • package.json
  • src/components/views/projects/qfBanner/ActiveQFProjectsBanner.tsx
  • src/components/views/projects/qfBanner/common.ts
Additional context used
Biome
src/helpers/number.ts

[error] 54-54: Use the '**' operator instead of 'Math.pow'. (lint/style/useExponentiationOperator)

Unsafe fix: Use the '**' operator instead of 'Math.pow'.


[error] 73-73: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead. (lint/suspicious/noGlobalIsNan)

See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.

src/helpers/qf.ts

[error] 44-44: Use the '**' operator instead of 'Math.pow'. (lint/style/useExponentiationOperator)

Unsafe fix: Use the '**' operator instead of 'Math.pow'.


[error] 61-61: Use the '**' operator instead of 'Math.pow'. (lint/style/useExponentiationOperator)

Unsafe fix: Use the '**' operator instead of 'Math.pow'.


[error] 62-65: Use the '**' operator instead of 'Math.pow'. (lint/style/useExponentiationOperator)

Unsafe fix: Use the '**' operator instead of 'Math.pow'.

Additional comments not posted (8)
src/components/views/archivedQFRounds/ArchivedQFRoundsTable.tsx (1)

42-42: Improved display of allocated funds using formatting.

The update to use formatPrice for displaying allocated funds enhances readability and consistency in the UI.

src/components/views/donate/EstimatedMatchingToast.tsx (1)

Line range hint 83-93: Enhanced formatting for estimated matching display.

The update to use formatDonation for formatting estimated matching amounts improves consistency and readability, aligning with changes in helper functions.

src/components/views/project/projectActionCard/QFSection.tsx (1)

85-93: Standardized formatting for donation amounts in quadratic funding sections.

The use of formatDonation for formatting donation amounts in various parts of the component ensures consistency and enhances readability.

Also applies to: 121-135

src/components/project-card/ProjectCard.tsx (2)

25-25: Approved import change for formatDonation.

The change to import formatDonation from @/helpers/number instead of the previous formatWithCurrency and getEstimatedMatchingRange is consistent with the PR's objective to simplify currency formatting logic.


Line range hint 238-253: Refactored currency formatting logic in the component.

The logic to format the estimated matching price has been refactored to use the new formatDonation function. This change simplifies the code and aligns with the PR's goal of improving clarity and maintainability.

However, ensure that the change in the function signature and the logic doesn't affect other components that might rely on the same calculations.

lang/en.json (2)

70-70: Updated description for quadratic funding banner:

The change in the description for the quadratic funding banner clarifies the importance of donor numbers over the donation amount, which is a key principle of quadratic funding. This change enhances clarity and aligns with the goals of promoting broader participation.


1219-1219: Updated label for custom Ethereum address:

The updated label now includes additional information about the benefits of accepting donations on multiple chains, which could potentially increase the likelihood of receiving donations. This is a positive change as it provides clearer instructions and benefits directly to the users.
[APROVED]

lang/es.json (1)

1219-1219: Updated localization for Spanish translation enhances clarity and inclusivity.

The updated text now includes additional information about accepting donations on multiple chains, which is likely to increase the appeal and accessibility of the platform for Spanish-speaking users.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Outside diff range and nitpick comments (2)
src/helpers/number.ts (1)

Line range hint 73-73: Use Number.isNaN instead of isNaN for type safety.

The global isNaN function coerces its argument to a number, which can lead to unexpected results. Using Number.isNaN provides a safer alternative that does not perform type coercion.

- if (isNaN(number)) {
+ if (Number.isNaN(number)) {
src/helpers/qf.ts (1)

Line range hint 44-44: Optimize mathematical expressions using the exponentiation operator.

The use of Math.pow can be replaced with the exponentiation operator (**) for clarity and to align with modern JavaScript best practices.

- const result = Math.min(
-    (Math.pow(projectDonationsSqrtRootSum, 2) / allProjectsSum) * matchingPool,
-    matchingPool * matchingCapPercentage,
- );
+ const result = Math.min(
+    ((projectDonationsSqrtRootSum ** 2) / allProjectsSum) * matchingPool,
+    matchingPool * matchingCapPercentage,
+ );

- const beforeNewDonationPow = Math.pow(_projectDonationsSqrtRootSum, 2);
- const afterNewDonationPow = Math.pow(
-    _projectDonationsSqrtRootSum + Math.sqrt(donationAmount),
-    2,
- );
+ const beforeNewDonationPow = _projectDonationsSqrtRootSum ** 2;
+ const afterNewDonationPow = (_projectDonationsSqrtRootSum + Math.sqrt(donationAmount)) ** 2;

Also applies to: 61-61, 62-65

@@ -60,7 +60,7 @@ export const formatDonation = (
if (num < threshold) return `< ${symbol}${threshold}`;
return !rounded
? symbol + num.toLocaleString(local, { maximumFractionDigits })
: symbol + Math.round(num);
: symbol + Math.round(num).toLocaleString(local);
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using the exponentiation operator for clarity and modern JavaScript syntax.

The use of Math.pow can be replaced with the exponentiation operator (**) for improved readability and to align with modern JavaScript practices.

- const threshold = Math.pow(10, -maximumFractionDigits);
+ const threshold = 10 ** -maximumFractionDigits;

Committable suggestion was skipped due to low confidence.

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