This is the central repository for the members of The Weekly Challenge. The members can submit the solution to the challenge each week in their favorite programming languages, although the preferred languages are Perl and Raku.
Saif Ahmed, respected member of Team PWC, created the tool 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.
Just submit a Pull Request with your solutions.
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.
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.
Let us assume you want to submit solutions for Challenge 002, and your GitHub user name is joe-blog.
-
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.
-
Go to your favorite terminal and clone your repository.
$ git clone https://github.com/joe-blog/perlweeklychallenge-club -
Create a new branch for the solution
$ cd perlweeklychallenge-club $ git checkout -b new-branch -
Go to the Challenge 002 folder.
$ cd challenge-002 -
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 -
Change into your named folder.
$ cd joe-blog -
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.
-
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).
-
Change into your relevant folder depending on your choice cd perl or cd raku.
-
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.
-
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 -
Commit your changes.
$ git commit -
Push your changes.
$ git push -u origin new-branch -
Now go to your fork repository in the GitHub web portal https://github.com/joe-blog/perlweeklychallenge-club
-
You should see a button to submit Pull Request.
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.
-
Checkout out the master branch first.
$ git checkout master -
Check if you have set up upstream.
$ git remote -vYou should see something similar:
origin https://github.com/joe-blog/perlweeklychallenge-club (fetch) origin https://github.com/joe-blog/perlweeklychallenge-club (push) upstream https://github.com/manwar/perlweeklychallenge-club (fetch) upstream https://github.com/manwar/perlweeklychallenge-club (push)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-clubCheck if you have everything set up correctly.
$ git remote -vIf you see a similar output as above, you have set up upstream correctly. Just so you know, you only need to do it once.
-
Now we need to fetch latest changes from the upstream.
$ git fetch upstream -
We will merge the changes into your local master branch.
$ git merge upstream/master --ff-only -
Push your master changes back to the repository.
$ git push -u origin master -
Now it is time to create a new branch for a new challenge
$ git checkout -b branch-for-challenge-005 -
Once you have a new branch ready, you can add your solutions or blog information.
$ cd challenge-005/joe-blog $ echo "URL to the blog" > blog.txt $ mkdir perl $ cd perl Add script like ch-1.pl or ch-2.pl or ch-1.sh or ch-2.sh $ mkdir raku $ cd raku Add script like ch-1.raku or ch-2.raku or ch-1.sh or ch-2.shTest your script now.
-
Commit your changes.
$ git add challenge-005/joe-blog $ git commit -
Now push the newly created branch branch-for-challenge-005
$ git push -u origin branch-for-challenge-005 -
Time to submit your changes as Pull Request.
Go to the GitHub web profile
https://github.com/joe-blog/perlweeklychallenge-club
You should see a button to create Pull Request.
Dave Cross wrote a very detailed blog post covering the minimum knowledge of git and GitHub needed to start contributing. Highly Recommended.
If you have any trouble with the above instructions then please get in touch with me anytime [email protected].