Open
Conversation
I made a pass through the README to update some things that have changed since I first wrote it. I didn't run it though, so there may still be some inconsistencies.
stefanp0pa
reviewed
May 22, 2022
| 1. Please make sure you've read through the [CONTRIBUTING.md](https://github.com/acs-upb-mobile/acs-upb-mobile/blob/master/CONTRIBUTING.md) file. | ||
| 2. Fork the [ACS UPB Mobile](https://github.com/acs-upb-mobile/acs-upb-mobile) repository. | ||
| 3. Clone the fork onto your system and open it as an Android Studio project. | ||
| 3. Clone the fork onto your system (`git clone`) and open it as an Android Studio project. |
There was a problem hiding this comment.
Since it is a workshop, I would suggest maybe giving a little mention that although there may be other code editors or IDEs for coding Flutter, Android Studio would be the recommended solution. Maybe put this as a little paranthesis in as few words as possible
stefanp0pa
reviewed
May 22, 2022
| |:--------:|:--------------------------------------------------------------| | ||
| | :bulb: |Did you skip that part in the first paragraph about following the [Prerequisites](https://github.com/student-hub/acs-upb-mobile#prerequisites) section before moving forward? Make sure you have everything installed, and **the correct Flutter version checked out**. Finally, you can try the troubleshooting steps [here](https://github.com/student-hub/acs-upb-mobile/blob/master/README.md#not-working).| | ||
|
|
||
|
|
There was a problem hiding this comment.
this section is gold for newbies:))) I do not see anything else to be added here since those sections provide each significant details.
stefanp0pa
reviewed
May 22, 2022
| 8. Create a pull request either from GitHub (you will see a message prompting you to create a PR when you open the forked repository) or Android Studio (VCS > Git > Create Pull Request). Make sure the PR points from the branch you created to the master branch in the acs-upb-mobile repo. Give it a meaningful name (refer to [How to Write a Git Commit Message](https://cbea.ms/git-commit/)). | ||
| 9. Wait for the PR to be approved. | ||
| 10. Pat yourself on the back. | ||
| 10. Pat yourself on the back, you've made your first steps as an open source contributor! |
stefanp0pa
reviewed
May 22, 2022
| You can see the latest version in the package's name. Specifying it is not mandatory, but it is recommended. You will often see a caret next to the version specified in pubspec files (e.g. `pie_chart: ^3.1.1`), symbolising "version 3.1.1 or the newest compatible version", or ">=3.1.1 <4.0.0", since a new major version usually implies breaking changes. | ||
|
|
||
| Android Studio will prompt you to run `flutter pub get` to update the dependencies of your project. Do so. | ||
| Android Studio will prompt you to run `flutter pub get` to update the dependencies of your project. Do so. If you see any issues, feel free to fall back to using 3.1.1 as the version - maybe since we've written this workshop, things have changed in the package and it doesn't work as it used to. For any package we use here, you can refer to the [pubspec.yaml](pubspec.yaml) file to see what version we've used when setting up the workshop. |
There was a problem hiding this comment.
... to update the dependencies of your project, and you should do so.
Like it better this way
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I made a pass through the README to update some things that have changed since I first wrote it. I didn't run it though, so there may still be some inconsistencies.