mirror of
https://github.com/Raghu-Ch/angular-challenges.git
synced 2026-02-10 12:53:03 -05:00
Merge pull request #107 from gsgonzalez88/fix/docs-typos
docs: typos found in documentation page
This commit is contained in:
@@ -1,13 +1,13 @@
|
|||||||
---
|
---
|
||||||
title: Checkout Somebody Answer
|
title: Check out Somebody's Answer
|
||||||
description: Guide to checkout the answer of someone else
|
description: Guide to checking out someone else's answer.
|
||||||
sidebar:
|
sidebar:
|
||||||
order: 3
|
order: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
All Angular Challenges answers will be presented in the form of a Pull Request (PR). To view and follow them, navigate through the **Files Changes** page on GitHub. However, understanding and following this process may not be straightforward if you are not familiar with the interface. In many cases, you may prefer to check out the branch and review the solution in your preferred IDE.
|
All Angular Challenges answers will be presented in the form of a Pull Request (PR). To view and follow them, navigate through the **Files Changes** page on GitHub. However, understanding and following this process may not be straightforward if you are not familiar with the interface. In many cases, you may prefer to check out the branch and review the solution in your preferred IDE.
|
||||||
|
|
||||||
This guide has been created to help you in archieving this.
|
This guide has been created to help you in achieving this.
|
||||||
|
|
||||||
## Checkout a PR locally from someone else
|
## Checkout a PR locally from someone else
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ sidebar:
|
|||||||
order: 5
|
order: 5
|
||||||
---
|
---
|
||||||
|
|
||||||
You have an idea you want to share, an interesting bug you are struggling with in one or your private or side project, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others.
|
You have an idea you want to share, an interesting bug you are struggling with in one of your private or side project, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others.
|
||||||
|
|
||||||
But how do you start creating these challenges?
|
But how do you start creating these challenges?
|
||||||
|
|
||||||
@@ -22,14 +22,14 @@ To streamline the process, I have created an Nx generator that will set up all t
|
|||||||
The title must be a maximum of 25 characters.
|
The title must be a maximum of 25 characters.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
- <b>challengeDifficulty</b>: The difficulty you think your challenge has. There are three difficulty level : 🟢 easy / 🟠 medium / 🔴 hard
|
- <b>challengeDifficulty</b>: The difficulty you think your challenge has. There are three difficulty levels : 🟢 easy / 🟠 medium / 🔴 hard
|
||||||
- <b>name</b>: name of the Nx application.
|
- <b>name</b>: name of the Nx application.
|
||||||
:::note
|
:::note
|
||||||
It must be written in **Kebab-Case**
|
It must be written in **Kebab-Case**
|
||||||
:::
|
:::
|
||||||
- <b>docRepository</b>: The category of your Challenge: Nx, Angular, Angular Performance, Rxjs, NgRx, Typescript.
|
- <b>docRepository</b>: The category of your Challenge: Nx, Angular, Angular Performance, Rxjs, NgRx, Typescript.
|
||||||
|
|
||||||
#### optinal parameters
|
#### optional parameters
|
||||||
|
|
||||||
- <b>directory</b>: If you want your application to be located in a specific folder inside `apps`.
|
- <b>directory</b>: If you want your application to be located in a specific folder inside `apps`.
|
||||||
- <b>addTest</b>: If you want to add test configuration.
|
- <b>addTest</b>: If you want to add test configuration.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ To get started with <b>Angular Challenges</b>, follow these steps:
|
|||||||
|
|
||||||
If you wish to submit an answer, you will need to have your own GitHub account. Additionally, having a GitHub account is always beneficial, and it's free.
|
If you wish to submit an answer, you will need to have your own GitHub account. Additionally, having a GitHub account is always beneficial, and it's free.
|
||||||
|
|
||||||
## Folk the github project
|
## Fork the github project
|
||||||
|
|
||||||
Navigate to the [Angular Challenges Repository](https://github.com/tomalaforge/angular-challenges) and click on the <span class="github-neutral-btn"> <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-repo-forked mr-2">
|
Navigate to the [Angular Challenges Repository](https://github.com/tomalaforge/angular-challenges) and click on the <span class="github-neutral-btn"> <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-repo-forked mr-2">
|
||||||
<path d="M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z"></path></svg>Fork</span> button in the header. This will create a copy of this repository on your own GitHub page.
|
<path d="M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z"></path></svg>Fork</span> button in the header. This will create a copy of this repository on your own GitHub page.
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ In this guide, you will learn how to resolve a challenge and submit an answer to
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This repository is powered by [Nx](https://nx.dev/getting-started/intro). <b>Nx</b> is a monorepository that allows you to store multiple applications inside the same workspace. Each challenge is a separate application. If you open the `apps` directory, you will found multiple directories, each related to a specific challenge. Each directory represents a complete standalone `Nx` application. To run and start with one, open your terminal and run:
|
This repository is powered by [Nx](https://nx.dev/getting-started/intro). <b>Nx</b> is a monorepository that allows you to store multiple applications inside the same workspace. Each challenge is a separate application. If you open the `apps` directory, you will find multiple directories, each related to a specific challenge. Each directory represents a complete standalone `Nx` application. To run and start with one, open your terminal and run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx nx serve <APPLICATION_NAME>
|
npx nx serve <APPLICATION_NAME>
|
||||||
@@ -46,7 +46,7 @@ Follow the instructions to resolve the challenge.
|
|||||||
|
|
||||||
The last step is to commit your work following the [Conventional Guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
|
The last step is to commit your work following the [Conventional Guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||||
|
|
||||||
Finally, push your work to the remote reposository with the following command
|
Finally, push your work to the remote repository with the following command
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git push --set-upstream origin <BRANCH_NAME>
|
git push --set-upstream origin <BRANCH_NAME>
|
||||||
@@ -58,9 +58,9 @@ You don't have to remember the command precisely. You just need to remember `git
|
|||||||
|
|
||||||
## Submit your Work to the Main Repository
|
## Submit your Work to the Main Repository
|
||||||
|
|
||||||
Now, all your work is located insite your local instance of the Angular Challenge repository.
|
Now, all your work is located insite your local instance of the Angular Challenges repository.
|
||||||
|
|
||||||
The next step is to go to the main [Angular Challenge page](https://github.com/tomalaforge/angular-challenges) and create a new Pull Request.
|
The next step is to go to the main [Angular Challenges page](https://github.com/tomalaforge/angular-challenges) and create a new Pull Request.
|
||||||
|
|
||||||
Github should display a notification header to help you create the pull request.
|
Github should display a notification header to help you create the pull request.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user