feat(docs): continue with docs

This commit is contained in:
thomas
2023-09-19 13:33:47 +02:00
parent b445f81aaf
commit c05629b6e4
5 changed files with 56 additions and 4 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

View File

@@ -22,7 +22,7 @@ git clone https://github.com/[YOUR_GITHUB_NAME]/angular-challenges.git
```
:::note
Your can find the url to clone on the button labeled <span class="code-btn"><> Code</span> on your **OWN INSTANCE** of the Angular Challenge repository.
Your can find the url to clone on the button labeled <span class="github-success-btn"><> Code</span> on your **OWN INSTANCE** of the Angular Challenge repository.
![Header of github workpspace](../../../assets/header-github.png)

View File

@@ -30,8 +30,60 @@ npm i -g nx
## Create a git branch
Before starting implementing your own solution to resolve a challenge, create a git branch to save your work.
Before starting implementing your own solution to resolve a challenge, create a git branch to commit your work.
```bash
git checkout -b <BRANCH_NAME>
```
## Resolve the challenge
Resolve the challenge following the instruction
## Commit and Push your work
Last step is to commit your work following the [Conventional Guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
Finaly, push your work to the remote reposository with the following command
```bash
git push --set-upstream origin <BRANCH_NAME>
```
:::tip[Don't remember it]
You don't have to remember the command precisely. You just need to remember `git push` and if it's the first time you are pushing this branch, `git` will give you the complete command.
:::
## Submit your work to the main repository
Now, all your work is located insite your local instance of the Angular Challenge repository.
Next step is to go to the main [Angular Challenge page](https://github.com/tomalaforge/angular-challenges) and create a new Pull Request.
Github should pop a notification header to help you create that pull request.
If it's not the case, you either have done one of the previous step wrong or you can go to the **Pull Request** tab and click the button <span class="github-success-btn">New pull request</span>.
Once you have choosen the two branches to compare, you should arrive on the following page:
![New pull request screen](../../../assets/new-pull-request.png)
Inside the title section, you should start with **Answer:** following by your **challenge number**, after that you are free to add anything you would like.
:::danger
This is very important. It lets other know what challenge you are trying to resolve
:::
Inside the description section, you can add questions, troubles you add or anything you want to share. You can leave it empty if you don't have anything to say.
You can now click on <span class="github-success-btn">Create pull request</span>.
I will read and comment on it when I have some free time.
:::note
Anybody is welcomed to comment and read other PR.
:::
:::tip[OSS champion]
🔥 Once you have completed this tutorial once, you are ready to go inside any other public github repository and submit a PR. It is as easy as that. 🔥
:::

View File

@@ -10,7 +10,7 @@
/* --sl-font: 'IBM Plex Serif', serif; */
}
.code-btn {
.github-success-btn {
border: 2px solid rgba(240, 246, 252, 0.1);
border-radius: 6px;
padding: 2px 8px;