diff options
| author | Mohammad Sajid Anwar <Mohammad.Anwar@yahoo.com> | 2023-10-03 14:22:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-03 14:22:07 +0100 |
| commit | c1bfbdc2269919b85579f941d22b5c6c9682fa99 (patch) | |
| tree | f2863defd6b686cc39eb9321a9038c7006943d86 | |
| parent | ff45eb209ad42ba45083d17a401d6d4402ff65c4 (diff) | |
| parent | 7585a5959cf9ebc33614ada94c3183ab53648b49 (diff) | |
| download | perlweeklychallenge-club-c1bfbdc2269919b85579f941d22b5c6c9682fa99.tar.gz perlweeklychallenge-club-c1bfbdc2269919b85579f941d22b5c6c9682fa99.tar.bz2 perlweeklychallenge-club-c1bfbdc2269919b85579f941d22b5c6c9682fa99.zip | |
Merge pull request #8808 from 3kho/master
Grammar
| -rw-r--r-- | README.md | 54 |
1 files changed, 27 insertions, 27 deletions
@@ -1,24 +1,24 @@ # The Weekly Challenge Club -This is the central repository for the members of [**The Weekly Challenge**](https://theweeklychallenge.org). The members can submit the solution to the challenge each week in their favourite programming languages, although the preferred languages are **Perl** and **Raku**. +This is the central repository for the members of [**The Weekly Challenge**](https://theweeklychallenge.org). The members can submit the solution to the challenge each week in their favorite programming languages, although the preferred languages are **Perl** and **Raku**. ## EZPWC - Easy Perl Weekly Challenges Script -**Saif Ahmed**, respected member of **Team PWC**, created the tool **[EZPWC](https://github.com/saiftynet/EZPWC)** to help you with contributing to the weekly challenge. We highly recommend you to give it a try. If you have any questions/suggestions, then please raise an issue against the tool. +**Saif Ahmed**, respected member of **Team PWC**, created the tool **[EZPWC](https://github.com/saiftynet/EZPWC)** to help you with contributing to the weekly challenge. We highly recommend you give it a try. If you have any questions/suggestions, then please raise an issue against the tool. ## How to contribute? -Just submit Pull Request with your solutions. +Just submit a Pull Request with your solutions. -First find out the latest challenge folder, more likely the highest numbered folder is the latest challenge folder e.g. challenge-002. If you are an existing member, you would probably find a folder by your name. For example, if your name is **"Joe Blog"** then there would be a folder called **"joe-blog"**. Under your named folder, you would find a file **README**. Depending on your choice of language, you should create a folder here e.g. **perl** for **Perl** and **raku** for **Raku**. Inside each of these folders you can save your solutions. If it is perl script for **Task #1** then call it **ch-1.pl**. Similarly if it is perl script for **Task #2** then call it **ch-2.pl**. For **Raku** solutions, call it **ch-1.raku** and **ch-2.raku** respectively. And if you are writing one-liner then call it **ch-1.sh** or **ch-2.sh**. If you are contributing for the first time, please create your named folder as described above. Also let us know what name you would like us to use? +First, find the latest challenge folder. The highest numbered folder is the latest challenge folder, e.g. challenge-002. You will probably find a folder by your name if you are an existing member. For example, if your name is **"Joe Blog"**, there would be a folder called **"joe-blog"**. Under your named folder, you will find a file **README**. Depending on your choice of language, you should create a folder here e.g. **perl** for **Perl** and **raku** for **Raku**. Inside each of these folders, you can save your solutions. If it is a Perl script for **Task #1**, call it **ch-1.pl**. Similarly, if it is a Perl script for **Task #2**, call it **ch-2.pl**. For **Raku** solutions, call it **ch-1.raku** and **ch-2.raku** respectively. And if you are writing a one-liner, call it **ch-1.sh** or **ch-2.sh**. If you are contributing for the first time, please create your named folder as described above. Also, let us know what name you would like us to use. -In case you have created a blog about your solutions, then create a file called **blog.txt** and add the link to it. In case you have more than one blog then create another file called **blog1.txt** and add your link there. +If you have created a blog about your solutions, then create a file called **blog.txt** and add the link. If you have more than one blog, create another file called **blog1.txt** and add your link there. ## Step-by-step instructions -Let us assume you want to submit solutions for **Challenge 002** and your Github user name is **joe-blog**. +Let us assume you want to submit solutions for **Challenge 002**, and your GitHub user name is **joe-blog**. -1. If you are submitting the solution for the first time then you have to **Fork** the repository **https://github.com/manwar/perlweeklychallenge-club** by clicking the **"Fork"** button in the top right corner and should have repository e.g. **https://github.com/joe-blog/perlweeklychallenge-club**. +1. If you are submitting the solution for the first time, then you have to **Fork** the repository **https://github.com/manwar/perlweeklychallenge-club** by clicking the **"Fork"** button in the top right corner and should have the repository, e.g. **https://github.com/joe-blog/perlweeklychallenge-club**. -2. Go to your favourite terminal and **clone** your repository. +2. Go to your favorite terminal and **clone** your repository. ``` $ git clone https://github.com/joe-blog/perlweeklychallenge-club ``` @@ -34,7 +34,7 @@ Let us assume you want to submit solutions for **Challenge 002** and your Github $ cd challenge-002 ``` -4. If you find a folder with your name in the current folder then skip to next step otherwise create a new folder. +4. If you find a folder with your name in the current folder, you can just go ahead and skip to the next step; otherwise, create a new folder. ``` $ mkdir joe-blog ``` @@ -44,15 +44,15 @@ Let us assume you want to submit solutions for **Challenge 002** and your Github $ cd joe-blog ``` -6. If you just created the folder then you should add a file **README** and add a line **Solution by Joe Blog** otherwise skip to next step. +6. If you just created the folder, you should add a file **README** and add a line **Solution by Joe Blog** otherwise, skip to the next step. -7. If you want to submit **Perl 5** solutions then you should create a folder **perl** (if not already created). Similarly if you want to submit **Raku** solutions then you should create a folder **raku** (if not already created). +7. If you want to submit **Perl 5** solutions, you should create a folder **perl** (if you still need to). Similarly, if you want to submit **Raku** solutions, then you should create a folder **raku** (if not already). 8. Change into your relevant folder depending on your choice **cd perl** or **cd raku**. -9. Now you are ready to add your solutions. If it is for the first challenge then create a file named **ch-1.pl** or **ch-1.raku** or **ch-1.sh**. Similarly, if it is for the second challenge then create a file named **ch-2.pl** or **ch-2.raku** or **ch-2.sh**. +9. Now you are ready to add your solutions. If it is for the first challenge, create a file named **ch-1.pl** or **ch-1.raku** or **ch-1.sh**. Similarly, if it is for the second challenge, create a file named **ch-2.pl** or **ch-2.raku** or **ch-2.sh**. -10. Once you are happy with your solutions, you should **add** it to the repository. First go back to **root** of the repository and then fire the command +10. Once you are happy with your solutions, add them to the repository. First, go back to **root** of the repository and then fire the command ``` $ git add challenge-002/joe-blog ``` @@ -67,20 +67,20 @@ Let us assume you want to submit solutions for **Challenge 002** and your Github $ git push -u origin new-branch ``` -13. Now go to your fork repository in GitHub web portal **https://github.com/joe-blog/perlweeklychallenge-club** +13. Now go to your fork repository in the GitHub web portal **https://github.com/joe-blog/perlweeklychallenge-club** 14. You should see a button to submit **Pull Request**. -## How to add new solution when you already have the forked repository? +## How to add a new solution when you already have the forked repository? -Let us assume you already have the repository forked. If this is the first time you are using the same forked repository for submitting subsequent challenges solution. I also assume your GitHub user name is **joe-blog**. +Let us assume you already have the repository forked. If this is the first time you use the same forked repository for submitting subsequent challenges solution. I also assume your GitHub user name is **joe-blog**. 1. Checkout out the **master** branch first. ``` $ git checkout master ``` -2. Check if you have setup **upstream**. +2. Check if you have set up **upstream**. ``` $ git remote -v ``` @@ -93,20 +93,20 @@ Let us assume you already have the repository forked. If this is the first time upstream https://github.com/manwar/perlweeklychallenge-club (push) ``` - If you don't see **upstream** as above then you need to setup your **upstream** like below: + If you don't see **upstream** as above, then you need to set up your **upstream** like below: ``` $ git remote add upstream https://github.com/manwar/perlweeklychallenge-club ``` - Check if you have everything setup correctly. + Check if you have everything set up correctly. ``` $ git remote -v ``` - If you see similar output as above then you have setup **upstream** correctly. - You only need to do it **once**. + If you see a similar output as above, you have set up **upstream** correctly. + Just so you know, you only need to do it **once**. 3. Now we need to **fetch** latest changes from the **upstream**. @@ -114,25 +114,25 @@ Let us assume you already have the repository forked. If this is the first time $ git fetch upstream ``` -4. We will now merge the changes into your local **master** branch. +4. We will merge the changes into your local **master** branch. ``` $ git merge upstream/master --ff-only ``` -5. Then push your **master** changes back to the repository. +5. Push your **master** changes back to the repository. ``` $ git push -u origin master ``` -6. Now it is time create new branch for new challenge +6. Now it is time to create a new branch for a new challenge ``` $ git checkout -b branch-for-challenge-005 ``` -7. Once you have a new **branch** ready, you can start adding your solutions or blog information. +7. Once you have a new **branch** ready, you can add your solutions or blog information. ``` $ cd challenge-005/joe-blog @@ -170,11 +170,11 @@ Let us assume you already have the repository forked. If this is the first time 10. Time to submit your changes as **Pull Request**. - Go to GitHub web profile + Go to the GitHub web profile https://github.com/joe-blog/perlweeklychallenge-club - You should see button to create **Pull Request**. + You should see a button to create **Pull Request**. `Dave Cross` wrote a very detailed [**blog post**](https://dev.to/davorg/learn-enough-git-and-github-to-take-part-in-the-perl-weekly-challenge-gpm) covering the minimum knowledge of `git` and `GitHub` needed to start contributing. Highly Recommended. |
