1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
# 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 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 give it a try. If you have any questions/suggestions, then please raise an issue against the tool.
## How to contribute?
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.
## Step-by-step instructions
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 the repository, e.g. **https://github.com/joe-blog/perlweeklychallenge-club**.
2. Go to your favorite terminal and **clone** your repository.
```
$ git clone https://github.com/joe-blog/perlweeklychallenge-club
```
3. Create a new branch for the solution
```
$ cd perlweeklychallenge-club
$ git checkout -b new-branch
```
3. Go to the **Challenge 002** folder.
```
$ cd challenge-002
```
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
```
5. Change into your named folder.
```
$ cd joe-blog
```
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, 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, 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, add them to the repository. First, go back to **root** of the repository and then fire the command
```
$ git add challenge-002/joe-blog
```
11. Commit your changes.
```
$ git commit
```
12. Push your changes.
```
$ git push -u origin new-branch
```
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 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 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 set up **upstream**.
```
$ git remote -v
```
You 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-club
```
Check if you have everything set up correctly.
```
$ git remote -v
```
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**.
```
$ git fetch upstream
```
4. We will merge the changes into your local **master** branch.
```
$ git merge upstream/master --ff-only
```
5. Push your **master** changes back to the repository.
```
$ git push -u origin master
```
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 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.sh
```
Test your script now.
8. Commit your changes.
```
$ git add challenge-005/joe-blog
$ git commit
```
9. Now push the newly created branch **branch-for-challenge-005**
```
$ git push -u origin branch-for-challenge-005
```
10. 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**](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.
If you have any trouble with the above instructions then please get in touch with me anytime <mohammad.anwar@yahoo.com>.
|
