mirror of
https://github.com/Raghu-Ch/angular-challenges.git
synced 2026-02-13 06:13:03 -05:00
docs(docs): update docs and set up all pages
This commit is contained in:
@@ -7,22 +7,22 @@ sidebar:
|
||||
|
||||
In this guide, you will learn how to resolve a challenge and submit an answer to the main Github repository.
|
||||
|
||||
## Presentation
|
||||
## Introduction
|
||||
|
||||
This repository is powered by [Nx](https://nx.dev/getting-started/intro). **Nx** is a monorepository allowing to store multiple application inside the same workspace. That's said, each challenges is a separate application. If you open the `apps` directory, you will found multiple directory all related to one challenge. Each directory is 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 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:
|
||||
|
||||
```bash
|
||||
npx nx serve <APPLICATION_NAME>
|
||||
```
|
||||
|
||||
:::note
|
||||
If you are not sure of your APPLICATION_NAME, open the README.md file. The `serve` command is written inside with a link to the documentation challenge.
|
||||
If you are unsure of your `APPLICATION_NAME`, open the README.md file. The `serve` command is written there, with a link to the challenge documentation.
|
||||
:::
|
||||
|
||||
:::note
|
||||
If `nx` is installed globally on your device, you can avoid using `npx`.
|
||||
If `nx` is installed globally on your device, you can skip using `npx`.
|
||||
|
||||
If you want to install `nx` globally, run
|
||||
To install `nx` globally, run
|
||||
|
||||
```bash
|
||||
npm i -g nx
|
||||
@@ -30,62 +30,62 @@ npm i -g nx
|
||||
|
||||
:::
|
||||
|
||||
## Create a git branch
|
||||
## Create a Git Branch
|
||||
|
||||
Before starting implementing your own solution to resolve a challenge, create a git branch to commit your work.
|
||||
Before you start implementing your 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
|
||||
|
||||
Resolve the challenge following the instruction
|
||||
Follow the instructions to resolve the challenge.
|
||||
|
||||
## Commit and Push your work
|
||||
## Commit and Push your Work
|
||||
|
||||
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/).
|
||||
|
||||
Finaly, push your work to the remote reposository with the following command
|
||||
Finally, 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.
|
||||
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 provide you with the complete command.
|
||||
:::
|
||||
|
||||
## 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.
|
||||
|
||||
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 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.
|
||||
Github should display a notification header to help you create the 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>.
|
||||
If it's not the case, you either have done one of the previous steps incorrectly or you can go to the <b>Pull Request</b> 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:
|
||||
Once you have chosen the two branches to compare, you should arrive on the following page:
|
||||
|
||||

|
||||
|
||||
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.
|
||||
In the title section, start with <b>Answer:</b> followed by your <b>challenge number</b>. 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
|
||||
This is very important. It lets others know which challenge you are attempting 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.
|
||||
In the description section, you can add questions, troubles you encountered, or anything else 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.
|
||||
Everyone is welcome to comment and read other PRs.
|
||||
:::
|
||||
|
||||
:::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. 🔥
|
||||
🔥 Once you have completed this tutorial, you are ready to contribute to any other public Github repository and submit a PR. It is as easy as that. 🔥
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user