From 1a4b6a31486c3cc891dc96b7b50934e649e3c05d Mon Sep 17 00:00:00 2001 From: Mohammad S Anwar Date: Tue, 2 Apr 2019 18:48:20 +0100 Subject: Added how to contribute instructions. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index fcf64aab94..3d38c6349a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ -## Perl Weekly Challenge Club +# Perl Weekly Challenge Club This is the central repository for the members of **Perl Weekly Challenge**. The members can submit the solution to the challenge each week under version control. + +## How to contribute? +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 "Job 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. **perl5** for Perl 5 and **perl6** for Perl 6. Inside each of these folders you can save your solutions. If it is perl5 script for challenge 1 then call it **ch-1.pl**. Similarly if it is perl5 script for challenge 2 then call it **ch-2.pl**. For perl6 solutions, call it **ch-1.p6** and **ch-2.p6** 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? + +In case you have created a blog about your solutions, then create a file called **blog.txt** and add the link to it. -- cgit From b0ebc4d44401cf8751be27da5b2454acd75538fe Mon Sep 17 00:00:00 2001 From: Mohammad S Anwar Date: Wed, 3 Apr 2019 15:51:04 +0100 Subject: Update README.md Minor tweak to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3d38c6349a..c0a00f6768 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ This is the central repository for the members of **Perl Weekly Challenge**. The members can submit the solution to the challenge each week under version control. ## How to contribute? +Just submit 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 "Job 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. **perl5** for Perl 5 and **perl6** for Perl 6. Inside each of these folders you can save your solutions. If it is perl5 script for challenge 1 then call it **ch-1.pl**. Similarly if it is perl5 script for challenge 2 then call it **ch-2.pl**. For perl6 solutions, call it **ch-1.p6** and **ch-2.p6** 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? In case you have created a blog about your solutions, then create a file called **blog.txt** and add the link to it. -- cgit From 38888aabe2b5f689b2ccd72a1d92cd4aff99b42f Mon Sep 17 00:00:00 2001 From: Mohammad S Anwar Date: Sun, 7 Apr 2019 09:01:44 +0100 Subject: Added step-by-step instructions for new to GitHub --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c0a00f6768..8bf36e3fb9 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,39 @@ This is the central repository for the members of **Perl Weekly Challenge**. The ## How to contribute? Just submit 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 "Job 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. **perl5** for Perl 5 and **perl6** for Perl 6. Inside each of these folders you can save your solutions. If it is perl5 script for challenge 1 then call it **ch-1.pl**. Similarly if it is perl5 script for challenge 2 then call it **ch-2.pl**. For perl6 solutions, call it **ch-1.p6** and **ch-2.p6** 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 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. **perl5** for Perl 5 and **perl6** for Perl 6. Inside each of these folders you can save your solutions. If it is perl5 script for challenge 1 then call it **ch-1.pl**. Similarly if it is perl5 script for challenge 2 then call it **ch-2.pl**. For perl6 solutions, call it **ch-1.p6** and **ch-2.p6** 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? In case you have created a blog about your solutions, then create a file called **blog.txt** and add the link to it. + +## Step-by-step instructions +Let us assume you want to subtmit 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 by clicking the "Fork" button in the top right corner and should have repository e.g. **https://github.com/joe-blog/perlweeklychallenge-club**. + +2. Go to your favourite terminal and **clone** your repository. e.g **git clone https://github.com/joe-blog/perlweeklychallenge-club**. + +3. Create a new branch for the solution **git checkout -b new-branch**. + +3. Go to the **Challenge 002** folder **cd perlweeklychallenge-club/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 **mkdir joe-blog**. + +5. Change into your named folder **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. + +7. If you want to submit **Perl 5** solutions then you should create a folder **perl5** (if not already created). Similarly if you want to submit **Perl 6** solutions then you should create a folder **perl6** (if not already created). + +8. Change into your relevant folder depending on your choice **cd perl5** or **cd perl6**. + +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.p6** or **ch-1.sh**. Similarly, if it is for the second challenge then create a file named **ch-2.pl** or **ch-2.p6** 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 **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 GitHub web portal **https://github.com/joe-blog/perlweeklychallenge-club** + +14. You should see a button to submit **Pull Request**. -- cgit