Skip to content

docs: Add FVM instructions in README #6464

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

TapItNinja
Copy link

@TapItNinja TapItNinja commented Mar 20, 2025

What

  • Added FVM setup instructions for freshers under "How to run the project" in the README to simplify setting up Flutter 3.27.2, improving onboarding for new contributors.

Screenshot

N/A (this is a text-only change to the README)

Fixes bug(s)

  • Fixes: N/A (no specific bug addressed; this is an enhancement)

Part of

  • 🎯 What can I work on ? (mobile app) #525 (improving contributor experience)
  • Part of my GSoC 2025 contribution to enhance developer experience (DevX) by addressing setup challenges for new contributors, as suggested by Malte.

@codecov-commenter
Copy link

codecov-commenter commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 5.87%. Comparing base (4d9c7fc) to head (1740c9b).
Report is 803 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop   #6464      +/-   ##
==========================================
- Coverage     9.54%   5.87%   -3.68%     
==========================================
  Files          325     496     +171     
  Lines        16411   29549   +13138     
==========================================
+ Hits          1567    1737     +170     
- Misses       14844   27812   +12968     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@teolemon teolemon changed the title docs: Add FVM instructions for freshers in README docs: Add FVM instructions in README Mar 23, 2025
@g123k
Copy link
Collaborator

g123k commented Mar 24, 2025

There's no .fvm config in this repo.
So unless you add it, changing the README is meaningless.

@github-throwaway
Copy link
Collaborator

github-throwaway commented Mar 24, 2025

I wouldnt say it’s meaningless because it addresses a point people repeatably have issues with. However, the benefit does increase if we have this configuration file as well.

@TapItNinja could you add that? Thanks ☺️
https://fvm.app/documentation/getting-started/configuration

@g123k
Copy link
Collaborator

g123k commented Mar 24, 2025

I wouldnt say it’s meaningless because it addresses a point people repeatably have issues with. However, the benefit does increase if we have this configuration file as well.

@TapItNinja could you add that? Thanks ☺️ fvm.app/documentation/getting-started/configuration

I'm sorry, but no. Is-there an issue to discuss this? -> No.

FVM only works with a configuration folder.
So, unless the folder is added, I don't understand why we should talk about it in the README…

@github-throwaway
Copy link
Collaborator

I'm not sure I follow what you are saying because the documentation explicitly says:

.fvmrc file

This file is automatically created when you run fvm use {version}

.fvm directory

Starting with version 3.0 and above, it is recommended to add the .fvm directory to your .gitignore file.

And I had the impression that basically every week somebody ask in the slack how to run the project and the proposed solution was usually to downgrade flutter.

@TapItNinja
Copy link
Author

@g123k @github-throwaway Thank you for your feedback.

You've raised a valid point about the FVM configuration. While the README instructions provide clear guidance, I understand the desire for a more comprehensive setup.

Key points:

  • The instructions help contributors set up Flutter 3.27.2 using FVM
  • As noted in the FVM documentation, .fvmrc is created automatically when running fvm use 3.27.2
  • The README addresses the frequent Slack questions about project setup

Proposed next steps:

  1. I'm happy to add the .fvm configuration if the team finds it beneficial
  2. We can discuss the specific configuration needs for the project
  3. The current instructions already simplify the onboarding process

Would you like me to draft a minimal .fvm configuration file for review?

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 PR: needs rebase
Projects
Status: 💬 To discuss and validate
Development

Successfully merging this pull request may close these issues.

4 participants