Files
angular-challenges/docs/src/content/docs/guides/resolve-challenge.md
2023-11-22 23:14:10 -05:00

3.6 KiB

title, description, sidebar
title description sidebar
Resolve a Challenge Guide to resolve a challenge
order
2

In this guide, you will learn how to resolve a challenge and submit an answer to the main Github repository.

Introduction

This repository is powered by Nx. Nx 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:

npx nx serve <APPLICATION_NAME>

:::note 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 skip using npx.

To install nx globally, run

npm i -g nx

:::

Create a Git Branch

Before you start implementing your solution to resolve a challenge, create a git branch to commit your work.

git checkout -b <BRANCH_NAME>

Resolve the Challenge

Follow the instructions to resolve the challenge.

Commit and Push your Work

The last step is to commit your work following the Conventional Guidelines.

Finally, push your work to the remote repository with the following command

    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 provide you with the complete command. :::

Submit your Work to the Main 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 Challenges page and create a new 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 steps incorrectly or you can go to the Pull Request tab and click the button New pull request.

Once you have chosen the two branches to compare, you should arrive on the following page:

New pull request screen

In the title section, start with Answer: followed by your challenge number. After that, you are free to add anything you would like.

:::danger This is very important. It lets others know which challenge you are attempting to resolve. :::

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 Create pull request.

I will read and comment on it when I have some free time.

Don't worry if your answer is not reviewed immediately. I'm doing it for free and during my free time. If you want to support me, you can do so by sponsoring me on github. It will validate that my work is of great help for you or your team.

:::note Everyone is welcome to comment and read other PRs. :::

:::tip[OSS champion] 🔥 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. 🔥 :::