diff --git a/docs/src/how-to/5-contribute-to-koma.md b/docs/src/how-to/5-contribute-to-koma.md index 7a7691734..d3be104c4 100644 --- a/docs/src/how-to/5-contribute-to-koma.md +++ b/docs/src/how-to/5-contribute-to-koma.md @@ -24,12 +24,9 @@ If you try to commit or generate a pull request at this point, you will get an ` To create this fork, go to the official [KomaMRI repository](https://github.com/JuliaHealth/KomaMRI.jl) and follow the steps below: -```@raw html - - - - -``` +![](../assets/create-fork-step1.png) +![](../assets/create-fork-step2.png) + ### 3. Access your GitHub account in VSCode Now, you need to ensure that your GitHub account is connected to VSCode. This allows you to clone repositories, create branches, and manage pull request directrly within VSCode. @@ -51,18 +48,13 @@ In VSCode, click on **File** -> **Open Folder...** and select your `~/.julia/dev Now add the fork URL by clicking **Source Control** -> **...** -> **Remote** -> **Add Remote...** ```@raw html - - - + ``` This will create the option to provide a repository URL. Here is where you will paste your fork URL and give it the name `my-fork`. -```@raw html - - - - -``` +![](../assets/create-remote-step1.png) +![](../assets/create-remote-step1.png) + >💡Press `Yes` when prompted to constantly fetch in the future. The Julia extension should automatically detect the `KomaMRI` environment. To check this, look at the status bar (bottom) end you should see `Julia env: KomaMRI`. If this is not the case, click the option in the menu bar and select KomaMRI.jl. @@ -103,18 +95,14 @@ If you did correctly follow the previous steps you will have correctly created y To create this new branch, go to **Source Control** -> **...** -> **Branch** -> **Create Branch form...** ```@raw html - - - + ``` This will open a menu to select an starting point for your branch. Select `my-fork/master` as your starting point, and give it the name `my-new-feature`. -```@raw html - - - - -``` + +![](../assets/create-branch-step1.png) +![](../assets/create-branch-step1.png) + >💡In your VScode terminal use `git status` to check if your branch is correctly created. Your branch should be listed at the top of the output. ## How to commit @@ -126,9 +114,7 @@ To do this, in VScode go to the Source Control panel in the Activity Bar. Assuming you are currently in your `my-new-feature` branch, the Source Control panel should show your changes to the project and the option to create a commit message. ```@raw html - - - + ``` If you hove over the `Changes` tab, it should show a `+` icon. Press it to stage all changes in the project. @@ -145,9 +131,7 @@ If you want to send your commited new version of the repository, you can create To create this pull request, in VScode, go to the `GitHub Pull Request` panel in the Activity Bar and hove over the `Pull request` tab. This should show a Create pull request icon to press. ```@raw html - - - + ``` In the `Create` tab that appears, select `JuliaHealth/master` as the base and the branch you are working with to merge. @@ -155,9 +139,7 @@ In the `Create` tab that appears, select `JuliaHealth/master` as the base and th To finish your pull request, give it a name with a clear mention of the subject of the contribution you made, and a description that explains the issue or feature you are addresing in your branch, and press the Create button. ```@raw html - - - + ``` >💡 **Tips for a successful Pull Request:** > - Try to address one issue or feature per pull request to make it easier for reviewers.