Merge pull request #130 from theperu/main

New guides for PRs and documentation

docs/PR-guide.md

@@ -0,0 +1,51 @@
+# GitHub for beginners
+
+So you want to partecipate in our project but you don't know how? Don't worry, this guide is here for you.
+In the next steps we will assume that you already completed the environment setup. If you haven't, make sure to follow *the first 3 steps* of [this guide](setup.md) first.
+
+## Step 1: Download GitHub Desktop
+
+This is pretty straightforward, go to this [link](https://desktop.github.com/) and download GitHub Desktop. With this it will be easier to manage and submit the changes that you will do. 
+After the download, set up your account.
+
+## Step 2: Clone the repository
+Now comeback to your repository on GitHub and click on Code -> Open with GitHub Desktop
+
+<div>
+    <img src="./assets/doc-guide/Clone-repo.png" width="1000" alt="Sossoldi icon">
+</div>
+
+This will open GitHub Desktop and it should ask you to add the path in which you want to save the folder with the project. Then click on clone.
+
+## Step 3: Make the changes
+
+Now you can open the project on your favorite IDE and make the changes that you want.
+
+## Step 4: Commit the changes
+
+When you are done, come back to GitHub Desktop and it should show the changes that you made on the left. Select the files that are necessary for the feature that you have implemented. Underneath them you will find the commit, write a description for the changes and click on commit.
+**NOTE:** most of the times you will see a lot changes here but you should select ONLY the files that you changed and are needed for the feature that you have implemented. You should also remove all the ones edited/created by your IDE.
+
+<div>
+    <img src="./assets/doc-guide/GitHub-Desktop.png" width="1000" alt="Sossoldi icon">
+</div>
+
+## Step 5: Push your changes
+
+On the top right now you should see the option to push your changes, after that they will be visible in your personal repository.
+
+## Step 6: Create the pull request
+
+Congrats this is the last step! Now go back to the [main repository](https://github.com/RIP-Comm/sossoldi/pulls) and create a new pull request by clicking on the top right. 
+
+<div>
+    <img src="./assets/doc-guide/PR-screen.png" width="1000" alt="Sossoldi icon">
+</div>
+
+Tap on “compare across forks” and then select your repository.
+After that tap on “Create pull request” and write a title and a description for it. 
+Congratulations now you are ready to submit it!
+
+Thank you for taking your time in helping our project!
+
+*If you want to learn a bit more about the differences between Git, GitHub and GitHub Desktop you can watch this [video](https://www.youtube.com/watch?v=8Dd7KRpKeaE&ab_channel=CoderCoder)*

docs/README.md

@@ -13,6 +13,8 @@ permalink: /
 -   [Information architecture](https://www.figma.com/file/xjVHAaHznRW1OFAJvp8DXn/Sossoldi-App---Figjam?node-id=0%3A1)
 -   [Interface study](https://www.notion.so/Sossoldi-Personal-finance-app-dd37eb9cbb2c44e59dd74f85e843e865)
 -   [Set up guide](setup.md)
+-   [GitHub for beginners](PR-guide.md)
+-   [Contribuiting to the documentation](doc-guide.md)
 
 ## About
 

docs/doc-guide.md

@@ -0,0 +1,37 @@
+# How to contribute to the documentation
+
+For our documentation we use GitHub Pages and this allows us to have a static page with all the info about the repo. This is very useful for use because it makes the docs easy to read and mantain by just using .md files that will then be converted to HTML. 
+If you want you can read more about GitHub Pages in the [official documentation](https://pages.github.com/), you can also read more about markdown files [here](https://www.markdownguide.org/getting-started/).
+In the next steps we will assume that you already completed the setup. If you haven't, make sure to follow [this guide](setup.md) first.
+
+## Step 1: Enable GitHub Pages inside your fork
+
+GitHub already offers a great guide on how to do this but basically what you need to do is:
+1. Go inside the your repository and select settings
+
+<div>
+    <img src="./assets/doc-guide/Repo-screen.png" width="1000" alt="Sossoldi icon">
+</div>
+
+2. Click **Pages** inside the section *Code and automation*.
+3. Then select **Deploy from branch** in *Source* and and make sure to select the main branch and the */docs* folder
+
+<div>
+    <img src="./assets/doc-guide/Settings-screen.png" width="1000" alt="Sossoldi icon">
+</div>
+
+4. You can now click **Save** and in a few seconds your page should be online at **{your-username}.github.io/sossoldi/**
+
+## Step 2: Make the changes in your repository
+
+Now that you have enabled the GitHub page you can start making changes and it's pretty straightforward. You can just make changes to the markdown files inside the *docs* folder or create new ones if are needed. 
+If you are making a new page make sure that it is linked to another so that the viewers will be able to reach it. Linking the markdown files it's pretty simple and you can find a lot of examples in our repo (you can also read more [here](https://www.codecademy.com/resources/docs/markdown/links)).
+
+Once you've finished making all the changes you can create a commit to your fork and in a few seconds the page should update with all the changes. At this point you should verify that everything looks great and that there are no issue reaching the page.
+
+## Step 3: Create a PR
+
+If everything went to plan now you should be able to create a PR explaing the changes that you made, in order to facilitate the review process make sure to explain what you have done and add useful screenschoots (if you prefer you can just share the link *{your-username}.github.io/sossoldi/*). 
+After the review process your PR will be merged and your changes should be online!
+
+*Don't know how to open a PR? Don't worry, you can read the [guide](PR-guide.md)*

docs/setup.md

@@ -6,7 +6,8 @@ Download and install Git from [https://git-scm.com/](https://git-scm.com/).
 
 ## Step 2: Install Flutter
 
-1. Download the Flutter SDK from [https://flutter.dev/docs/get-started/install](https://flutter.dev/docs/get-started/install).
+Installing flutter is slightly different between Windows, MacOS and Linux. Flutter already has a good step-by-step that you can find [here](https://docs.flutter.dev/get-started/install)
+1. Download the Flutter SDK from [flutter.dev/docs/get-started/install](https://flutter.dev/docs/get-started/install).
 2. Extract the downloaded archive to a location on your machine.
 3. Add the Flutter `bin` directory to your system's `PATH` variable.