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

Update Branding #52

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Conversation

ckorhonen
Copy link
Contributor

@ckorhonen ckorhonen commented Sep 19, 2024

User description

Updates to our Readme to reflect our new brand - Rally!


PR Type

documentation


Description

  • Updated the README file to reflect the rebranding from "Floor" to "Rally".
  • Changed all instances of "Floor" to "Rally" to ensure consistency with the new brand identity.
  • Adjusted descriptions and context to align with the new branding and application name.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README to reflect new Rally branding                           

README.md

  • Updated references from "Floor" to "Rally" to reflect rebranding.
  • Modified descriptions to align with the new brand identity.
  • Ensured consistency in branding throughout the document.
  • +6/-6     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Sep 19, 2024
    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Provide a brief explanation of Ingestors to clarify their role in Mobile Minting

    Consider adding a brief explanation of what "Ingestors" are and why they are
    important for Mobile Minting. This will help new contributors understand the concept
    more quickly.

    README.md [17]

    -This repository is a **public, contributable collection of Ingestors** that teach Mobile Minting how to support mints from new platforms.
    +This repository is a **public, contributable collection of Ingestors** that teach Mobile Minting how to support mints from new platforms. Ingestors are specialized modules that extract and process mint information from various blockchain platforms, enabling Rally to support a wide range of minting options.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Adding an explanation of "Ingestors" helps new contributors understand their importance, improving the document's accessibility and educational value for those unfamiliar with the concept.

    8
    Provide more details about the Ingestor review process to set clear expectations for contributors

    Consider adding information about the review process for submitted Ingestors,
    including expected timeline and criteria for acceptance. This can help set
    expectations for contributors and encourage more submissions.

    README.md [373]

    -In time, we hope to continue down this path, but for now all ingestors will be reviewed by the Rally engineering team & accepted on the basis of safety, cost & other considerations by Rally.
    +In time, we hope to continue down this path, but for now all ingestors will be reviewed by the Rally engineering team & accepted on the basis of safety, cost & other considerations by Rally. The review process typically takes 1-2 weeks, and we prioritize Ingestors that are well-documented, thoroughly tested, and align with our security standards. We encourage contributors to review our submission guidelines before submitting their Ingestors.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Detailing the review process and criteria sets clear expectations for contributors, potentially increasing the quality and quantity of submissions by providing guidance on what is expected. This can lead to a more efficient and effective contribution process.

    8
    Add context for the app name change to help users understand the rebranding

    Consider adding a brief explanation of why the app name was changed from Floor to
    Rally. This can help users understand the context of the rebranding and maintain
    continuity for those familiar with the old name.

    README.md [2]

    -Mobile Minting unlocks mobile payments for onchain purchases and powers minting in the Rally app (formerly known as Floor!).
    +Mobile Minting unlocks mobile payments for onchain purchases and powers minting in the Rally app (formerly known as Floor). This rebranding reflects our commitment to fostering community engagement and growth in the blockchain space.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion provides additional context for the rebranding, which can help users understand the reason behind the name change. This enhances the document's clarity and continuity for users familiar with the old name.

    7
    Highlight the benefits of community contributions to the Ingestors collection

    Consider adding a note about the potential benefits of community-contributed
    Ingestors, such as increased diversity of supported platforms and faster integration
    of new minting options.

    README.md [19]

    -Historically, only Rally could choose what mints users could mint through Rally based on our roadmap, or partnerships, now anyone can build support for any minting platform / product and (provided it meets some safety & reliability checks) it can be included in Mobile Minting.
    +Historically, only Rally could choose what mints users could mint through Rally based on our roadmap, or partnerships. Now, anyone can build support for any minting platform / product and (provided it meets some safety & reliability checks) it can be included in Mobile Minting. This community-driven approach allows for a wider range of supported platforms and faster integration of new minting options, benefiting all users of the Rally app.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion emphasizes the advantages of community contributions, which can motivate participation and highlight the potential for a more diverse and rapidly evolving platform.

    7

    💡 Need additional feedback ? start a PR chat

    Copy link

    CI Failure Feedback 🧐

    Action: build

    Failed stage: Run Tests [❌]

    Failed test name: foundation

    Failure summary:

    The action failed due to multiple test failures:

  • foundation test failed in createMintTemplateForUrl because the expected value '7700000000000000' did
    not match the actual value '0'.
  • highlight test failed in supportsUrl because the expected result was true, but the actual result was
    false.
  • highlight test failed in createMintTemplateForUrl due to an IncompatibleUrl error.
  • HighlightIngestor-auto test failed in supportsUrl because the expected result was true, but the
    actual result was false.
  • HighlightIngestor-auto test failed in createMintTemplateForUrl due to an IncompatibleUrl error.
  • rarible test failed in createMintTemplateForUrl because the expected value '1725163200000' did not
    match the actual value '+0'.

  • Relevant error logs:
    1:  ##[group]Operating System
    2:  Ubuntu
    ...
    
    513:  ✅ Simulation success
    514:  ✔ createMintTemplateForUrl: Returns a mint template for a supported URL (1253ms)
    515:  ✔ createMintForContract: Returns a mint template for a supported contract (514ms)
    516:  fxhash
    517:  ✔ supportsUrl: Returns false for an unsupported URL
    518:  ✔ supportsUrl: Returns true for a supported URL
    519:  ✔ createMintTemplateForUrl: Returns a mint template for a supported URL with frame contract (300ms)
    520:  ✔ createMintTemplateForUrl: Returns a mint template for a supported URL with fixed price contract (182ms)
    521:  ✔ createMintTemplateForUrl: Throws error if the mint for fxhash is on mainnet or tezos (2010ms)
    522:  ✔ createMintTemplateForUrl: Throws error if incompatible URL
    523:  ✔ createMintTemplateForUrl: Throws error if non-existent project (1922ms)
    524:  ✔ createMintTemplateForContract: Returns a mint template for a supported contract (64ms)
    525:  ✔ createMintTemplateForContract: Throws error for a non supported contract (40ms)
    ...
    
    585:  rarible
    586:  ✔ supportsUrl: Returns false for an unsupported URL
    587:  ✔ supportsUrl: Returns true for a supported URL
    588:  ✔ supportsContract: Returns false for a unsupported contract (1181ms)
    589:  ✔ supportsContract: Returns true for a supported contract (1633ms)
    590:  ✔ supportsContract: Returns false for a non base chain supported contract (737ms)
    591:  ✔ createMintForContract: Returns a mint template for a supported base contract (1128ms)
    592:  6) createMintTemplateForUrl: Returns a mint template for a supported URL
    593:  ✔ createMintTemplateForUrl: Throws error if incompatible URL
    ...
    
    656:  ✔ ERC7160TL stack (562ms)
    657:  ✔ ERC721TL stack (469ms)
    658:  createMintTemplateForContract: Returns a mint template for a supported contract
    659:  ✔ ERC1155TL contract at 0x7c3a99d4a7adddc04ad05d7ca87f4949c1a62fa8 (289ms)
    660:  ✔ ERC7160TL contract at 0xd2f9c0ef092d7ffd1a5de43b6ee546065461887d (314ms)
    661:  ✔ ERC721TL contract at 0x999f084f06ee49a3deef0c9d1511d2f040da4034 (254ms)
    662:  103 passing (1m)
    663:  1 pending
    664:  6 failing
    665:  1) foundation
    666:  createMintTemplateForUrl: Returns a mint template for a supported URL with frame contract:
    667:  AssertionError: expected '0' to equal '7700000000000000'
    668:  + expected - actual
    669:  -0
    670:  +7700000000000000
    671:  at Context.<anonymous> (test/ingestors/foundation.test.ts:69:42)
    672:  at processTicksAndRejections (node:internal/process/task_queues:95:5)
    673:  2) highlight
    674:  supportsUrl: Returns true for a supported URL:
    675:  AssertionError: expected false to be true
    ...
    
    682:  createMintTemplateForUrl: Returns a mint template for a supported URL:
    683:  IncompatibleUrl: Incompatible URL
    684:  at HighlightIngestor.createMintTemplateForUrl (src/ingestors/highlight/index.ts:140:13)
    685:  at processTicksAndRejections (node:internal/process/task_queues:95:5)
    686:  at async Context.<anonymous> (test/ingestors/highlight.test.ts:57:22)
    687:  4) highlight
    688:  HighlightIngestor-auto
    689:  supportsUrl: Returns true for a supported URL:
    690:  AssertionError: expected false to be true
    ...
    
    697:  HighlightIngestor-auto
    698:  createMintTemplateForUrl: Returns a mint template for a supported URL:
    699:  IncompatibleUrl: Incompatible URL
    700:  at HighlightIngestor.createMintTemplateForUrl (src/ingestors/highlight/index.ts:140:13)
    701:  at processTicksAndRejections (node:internal/process/task_queues:95:5)
    702:  at async Context.<anonymous> (test/shared/basic-ingestor-tests.ts:49:26)
    703:  6) rarible
    704:  createMintTemplateForUrl: Returns a mint template for a supported URL:
    705:  AssertionError: expected +0 to equal 1725163200000
    ...
    
    763:  mint-template-builder.ts   |    71.3 |    65.51 |   53.12 |    71.3 | ...,210-212,215-217,220-222 
    764:  lib/simulation              |   71.07 |    59.25 |      70 |   71.07 |                             
    765:  simulation.ts              |   64.53 |    61.11 |   66.66 |   64.53 | ...0-74,125,127,131,138-141 
    766:  tenderly.ts                |   85.71 |    55.55 |      75 |   85.71 | 52-60                       
    767:  lib/simulation/types        |     100 |      100 |     100 |     100 |                             
    768:  tenderly.types.ts          |     100 |      100 |     100 |     100 |                             
    769:  lib/types                   |     100 |      100 |     100 |     100 |                             
    770:  index.ts                   |     100 |      100 |     100 |     100 |                             
    771:  mint-ingestor-error.ts     |     100 |      100 |     100 |     100 |                             
    772:  mint-ingestor.ts           |     100 |      100 |     100 |     100 |                             
    773:  mint-template.ts           |     100 |      100 |     100 |     100 |                             
    774:  -----------------------------|---------|----------|---------|---------|-----------------------------
    775:  error Command failed with exit code 6.
    776:  info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
    777:  ##[error]Process completed with exit code 6.
    

    ✨ CI feedback usage guide:

    The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
    The tool analyzes the failed checks and provides several feedbacks:

    • Failed stage
    • Failed test name
    • Failure summary
    • Relevant error logs

    In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

    /checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
    

    where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

    Configuration options

    • enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
    • excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
    • enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
    • persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
    • final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

    See more information about the checks tool in the docs.

    @chrismaddern chrismaddern merged commit e317914 into main Sep 24, 2024
    1 check failed
    @chrismaddern chrismaddern deleted the ck/flo-590-update-mobile-minting-repo-readme branch September 24, 2024 09:47
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants