Skip to content

Commit ce3f57b

Browse files
FahimFBAFahimFBA
committed
add: How-to
1 parent 18d684a commit ce3f57b

31 files changed

+1698
-0
lines changed

‎pages/How-to/README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<div align="center">
2+
<h3>Step by step guide to perform activites like "Raising a PR", "Cloning a repo", etc.</h3>
3+
<p>Each topic/guide has its own separate Markdown file with detailed explanation which contanins <b>text, screenshot, screen recording, GIF,</b> etc.</p>
4+
</div>
5+
6+
<br>
7+
8+
|#|Activities| Click to Learn |
9+
|:--:|:---:|:--:|
10+
|**0**|![Raising an Issue](https://user-images.githubusercontent.com/51878265/188309274-6f4f6edc-22e3-44c8-8cd8-fe06c5831b55.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/rasing-issue.md)|
11+
|**1**|![Raising an Issue with Template](https://user-images.githubusercontent.com/51878265/188309271-f8e0a209-dc13-4251-962c-8d27c078fa05.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/raise-issue-template.md)|
12+
|**2**|![Create a PR](https://user-images.githubusercontent.com/51878265/188309287-db49d33a-57b3-48da-8161-c61644a0d4d5.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/creating-pr.md)|
13+
|**3**|![Add a sponsor](https://user-images.githubusercontent.com/51878265/188309822-df4ac84f-2056-4a04-80a5-aa0d86f0e696.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/adding-sponsor.md)|
14+
|**4**|![discussion](https://user-images.githubusercontent.com/51878265/188309284-f9b3e9aa-fb8e-4960-a380-6adc41244b23.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/starting-discussion.md)|
15+
|**5**|![link an Issue to PR](https://user-images.githubusercontent.com/51878265/188309282-19fe9212-fde7-4aea-bcac-aabc910dc2c6.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/linking-issue-with-pr.md)|
16+
|**6**|![Review a PR](https://user-images.githubusercontent.com/51878265/188309280-49929746-88cd-4991-83f4-258945ac9f5e.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/reviewing-pr.md)|
17+
|**7**|![Clone a repo](https://user-images.githubusercontent.com/51878265/188309279-0cb30417-d171-4dad-81b0-4e9b133c3084.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/cloning-repo.md)|
18+
|**8**|![Add Issue templates](https://user-images.githubusercontent.com/51878265/188309278-28797c1c-30dc-4a14-85f0-ccfd915d7557.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/adding-issue-template.md)|
19+
|**9**|![Add PR template](https://user-images.githubusercontent.com/51878265/188309276-e1ceddc7-d510-4cdb-8863-696b38210e4f.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/adding-pr-template.md)|
20+
|**10**|![Assign an Issue](https://user-images.githubusercontent.com/51878265/188309269-3369b50a-f0f9-43be-bec1-1f23c9eb6149.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/assigning-issue.md)|
21+
|**11**|![Fork a Repo](https://user-images.githubusercontent.com/51878265/188309267-fb2e4161-e910-40cf-b9f6-99068ad75211.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/fork-repo.md)|
22+
|**12**|![star a Repo](https://user-images.githubusercontent.com/51878265/188309275-bcdb9062-662c-4aaa-809f-366019696019.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/star-repo.md)|
23+
|**13**|![Delete a repo](https://user-images.githubusercontent.com/51878265/188317787-0a10a050-e7a6-4519-9dc5-64f360ece3e5.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/delete-repo.md)|
24+
|**14**|![Add social preview to a repo](https://user-images.githubusercontent.com/51878265/188317788-609caefe-4f7a-4101-a051-1a12d2723fbb.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/social-preview.md)|
25+
|**15**|![Use GitHub Pages](https://user-images.githubusercontent.com/51878265/188317790-9e1a365a-e51b-4d01-9529-91405d08eacb.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/github-pages.md)|
26+
|**16**|![Create a GitHub secret](https://user-images.githubusercontent.com/51878265/188317785-7edb7a69-36af-481a-b373-c1718f5fd23f.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-github-secret.md)|
27+
|**17**|![Create a license](https://user-images.githubusercontent.com/51878265/188317793-4fe89294-ee13-4dc5-9cb2-529851c23e1d.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-licence.md)|
28+
|**18**|![Create a Tag](https://user-images.githubusercontent.com/51878265/188317795-60a1284b-0590-4a7f-bd6e-f299b688c7c1.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-tags.md)|
29+
|**19**|![Create Releases](https://user-images.githubusercontent.com/51878265/188317799-c7ecba97-8b53-42cd-8db1-9287fb3c7817.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-releases.md)|
30+
|**20**|![Create a Project Board](https://user-images.githubusercontent.com/51878265/188317800-e91ddbe0-a079-48f0-bc63-1f69113691cf.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-project-board.md)|
31+
|**21**|![Archive a Repo](https://user-images.githubusercontent.com/51878265/188317801-3ec66402-fcf2-4818-95a7-1d489caf65ae.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/archive-repo.md)|
32+
|**22**|![Make a repo private/public](https://user-images.githubusercontent.com/51878265/188317804-4e45d315-e6f5-4338-90c7-70a2e5f09a28.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/repo-private-public.md)|
33+
|**23**|![Create-a-repo](https://user-images.githubusercontent.com/51878265/195158675-fb525b73-6a88-4143-bb5d-cd51d50f2a7a.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-repo.md)|
34+
|**24**|![Renaming a Repository](https://user-images.githubusercontent.com/51878265/194721906-86e2acba-194e-4dcc-8886-17f6b729a4c6.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/rename-repo.md)|
35+
|**25**|![Sign-commits](https://user-images.githubusercontent.com/51878265/194722406-73e2a603-c360-48dd-88bb-232abc170e81.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/sign-commits.md)|
36+
|**26**|![Create a branch](https://user-images.githubusercontent.com/51878265/195896447-42001878-e09e-4ac2-a79e-203b5cbaeeb4.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/create-branch.md)
37+
|**27**|![Review a PR on our local system](https://user-images.githubusercontent.com/51878265/198944333-6357ae5e-531b-421e-bc01-4904665da912.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/review-pr-locally.md)|
38+
|**28**|![Use GitHub Codespaces](https://user-images.githubusercontent.com/51878265/206258171-df44aff5-92b2-4f7e-926b-ff1efd06af85.png)|[![btn](https://user-images.githubusercontent.com/51878265/188311903-d9825c83-db42-45ba-8e1b-d8d9f2c78b09.png)](guide/use-codespaces.md)|
39+
||||
40+
41+
<br>
42+
<h4 align="center">Don't forget to ⭐ this <a href="https://github.com/Pradumnasaraf/open-source-with-pradumna">repo</a></h4>
43+

‎pages/How-to/guide/adding-issue-template.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# How to create issue templates ?
2+
An issue template is a template with prepopulated information about how an issue can be mentioned.
3+
4+
## Step by step process to create an issue template :
5+
6+
### Step 1 :
7+
8+
You should have a repository.
9+
10+
### Step 2 :
11+
12+
Go to the main page of the repository. Under the repository name, click Settings.
13+
14+
<img width="971" alt="Screenshot 2022-10-03 at 8 02 52 PM" src="https://user-images.githubusercontent.com/47234407/193889955-d37b9033-7892-4c12-90a5-7a731b57a129.png">
15+
16+
### Step 3 :
17+
18+
Scroll down to the "*Features*" section. Under "Issues", click on "*Set up templates*".
19+
20+
<img width="826" alt="Screenshot 2022-10-04 at 11 25 22 PM" src="https://user-images.githubusercontent.com/47234407/193891838-9d571171-133a-482e-b1bb-ea385305e713.png">
21+
22+
### Step 4 :
23+
24+
Click on the *Add template* drop-down menu, and select the type of template you'd like to create
25+
- Bug report - This template is used to convey the detailed information about the bug to the developers.
26+
- Feature request - It is a document where developers make requests for a product in development.
27+
- Custom template - This template is completely user controlled and can be customized according to needs.
28+
29+
<img width="408" alt="Screenshot 2022-10-04 at 11 43 37 PM" src="https://user-images.githubusercontent.com/47234407/193894578-76c96778-aec1-4c66-9237-6c3c74302b8c.png">
30+
31+
### Step 5 :
32+
33+
You can click on *Preview and edit* to view and edit the template.
34+
35+
<img width="802" alt="Screenshot 2022-10-04 at 11 46 38 PM" src="https://user-images.githubusercontent.com/47234407/193895400-0dd611bc-04ba-4eb1-9f5c-2c9e0de607ca.png">
36+
37+
### Step 6 :
38+
39+
Click on the pencil icon to edit the template and type in the fields to edit their contents.
40+
41+
<img width="812" alt="Screenshot 2022-10-04 at 11 50 46 PM" src="https://user-images.githubusercontent.com/47234407/193896158-7d5e20cb-7bea-4a60-b2a5-19fd3961204c.png">
42+
43+
### Step 7 :
44+
45+
Enter the information under "Optional additional information" to automatically set a default issue title, assign the issue to users with read access to the repository, or apply labels to your issue template. In a YAML format, you can also include these details in the issue template along with the title, labels, or assignees.
46+
47+
<img width="795" alt="Screenshot 2022-10-04 at 11 55 57 PM" src="https://user-images.githubusercontent.com/47234407/193896767-9ce84001-c9ba-4dea-9ec0-a679124acf6f.png">
48+
49+
### Step 8 :
50+
51+
Click on *Propose changes* in the top right corner of the page once you're done altering and previewing your template.
52+
53+
<img width="1002" alt="Screenshot 2022-10-04 at 11 58 43 PM" src="https://user-images.githubusercontent.com/47234407/193897353-bf7fb5d3-93eb-41be-a5f4-7de36c6df1a4.png">
54+
55+
### Step 9 :
56+
57+
Write a commit message summarizing the changes you made.
58+
59+
<img width="446" alt="Screenshot 2022-10-05 at 12 01 29 AM" src="https://user-images.githubusercontent.com/47234407/193897863-5ea95c93-e40e-4fdb-a3f4-bc1dfd8af0c7.png">
60+
61+
### Step 10 :
62+
63+
Choose whether to establish a new branch and launch a pull request or to commit your template directly to the default branch underneath the commit message boxes.
64+
65+
<img width="450" alt="Screenshot 2022-10-05 at 12 04 37 AM" src="https://user-images.githubusercontent.com/47234407/193898357-cbda1b6b-2a6e-41b9-b20a-48eaf1c5adc5.png">
66+
67+
### Step 11 :
68+
69+
Click on *Commit changes*. The template will be accessible for contributors to use when they open new issues in the repository once these modifications are merged into the default branch.
70+
71+
<img width="445" alt="Screenshot 2022-10-05 at 12 06 57 AM" src="https://user-images.githubusercontent.com/47234407/193898983-d1684258-74df-4f7d-9dcc-705c715e3aff.png">

‎pages/How-to/guide/adding-pr-template.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Create a PR Template
2+
3+
Creating a PR template makes it easy to clarify what the proposed changes will do and receive actionable feedback from your team. Having a custom template facilitates clear communication between all team members and ensures that everyone is on the same page.
4+
5+
You can create a `PULL_REQUEST_TEMPLATE/ subdirectory` in any of the supported folders to contain multiple pull request templates, and use the template query parameter to specify the template that will fill the pull request body.
6+
7+
### Steps to successfully create a PR Template :
8+
#### There are two steps ways in which you can create a PR Template:
9+
1. To store your file in a hidden directory, name the pull request template `.github/pull_request_template.md`:
10+
11+
<div align="center">
12+
<img src="https://user-images.githubusercontent.com/78820926/172212505-5eb9d121-3dcc-4ef2-87dd-06cdcc9e6396.png" alt="Creating a new file using the 'Create new file' option under the 'Add file' button" />
13+
</div>
14+
</br>
15+
<div align="center">
16+
<img src="https://user-images.githubusercontent.com/78820926/172214830-3f858f92-da44-41ec-82cb-1325ec3d7742.png" alt="Naming the file as 'pull_request_template.md'" />
17+
</div>
18+
</br>
19+
20+
2. After creating the `pull_request_template.md` file you have to write the body of the new file, add your pull request template. This could include:
21+
a. A reference to a related issue in your repository.
22+
b. A description of the changes proposed in the pull request.
23+
c. Mention the person or team responsible for reviewing proposed changes.
24+
25+
<!-- Here is the demo of a template:
26+
<div align="center">
27+
<img src="https://user-images.githubusercontent.com/78820926/172215461-89812839-a0fd-4614-b5f5-10242dd78328.png" alt="Demo template for 'pull_request_template.md" />
28+
</div>
29+
</br> -->
30+
31+
32+
#### That's it. You have sucessfully created a PR Template

‎pages/How-to/guide/adding-sponsor.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
# Adding a sponsor button to your repository
3+
4+
## What is GitHub Sponsor?
5+
The mission of GitHub Sponsors is to provide opportunities to participate in and build on open source. The advent of GitHub Sponsors and other third-party sponsorship models helps our industry take the right steps in making open source careers possible. GitHub Sponsors offers a native solution for individuals and corporations to sponsor open source maintainers and contributors.
6+
7+
### An example of a sponsorship eligible project :
8+
9+
![sponsorship-eligible-image](https://user-images.githubusercontent.com/70484406/181913879-e27e4717-3b84-48e5-868c-5ce3c1f0a9fe.png)
10+
11+
### Who are eligible for getting sponsored?
12+
Anyone who contributes to an open source project and lives in a supported region is eligible to become a sponsored developer. Contributions include but are not limited to bug reports, issue triage, code, documentation, leadership, business development, project management, mentorship, and design. If you live in a region that isn't already supported by GitHub Sponsors, you can sign up for the waitlist to participate in the GitHub Sponsors.
13+
14+
### How to display a sponsor button in your repository
15+
Anyone with admin permissions can enable a sponsor button in a repository.
16+
17+
1. On GitHub.com, navigate to the main page of the repository.
18+
19+
2. Under your repository name, click `Settings`.
20+
21+
![setting-button-image](https://user-images.githubusercontent.com/70484406/181914892-67fd3b52-ca74-4850-9d26-8b5201a0b272.png)
22+
23+
3. Under Features, select `Sponsorships`.
24+
25+
![sponsorship-setting-checkbox](https://user-images.githubusercontent.com/70484406/181915056-1ab7284a-10f2-4804-935a-d124a75ab7f7.png)
26+
27+
4. Under `Sponsorships`, click `Set up sponsor button`.
28+
29+
![setup-sponsor-button-image](https://user-images.githubusercontent.com/70484406/181915245-e6744a6b-e38b-4d99-97ed-955ac794d728.png)
30+
31+
5. In the file editor, follow the instructions in the `FUNDING.yml` file to add links to your funding locations.
32+
33+
![FUNDING.yml-file-image](https://user-images.githubusercontent.com/70484406/181915396-850c7740-bdde-4662-a0ed-edc842d64b09.png)
34+
35+
6. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file.
36+
37+
![commit-message-input-image](https://user-images.githubusercontent.com/70484406/181915551-593617d0-e7df-4ebe-9b31-bc50a39c3e55.png)
38+
39+
7. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. For more information, see ["Create a new pull request"](https://github.com/Pradumnasaraf/open-source-with-pradumna/blob/main/pages/How-to/guide/creating-pr.md)
40+
41+
![new-branch-radio-button-image](https://user-images.githubusercontent.com/70484406/181916164-634b7e99-2cb4-4346-a0a3-cfa95c3a4d2c.png)
42+
43+
8. Click `Propose new file`.
44+
45+
![propose-new-file-button-image](https://user-images.githubusercontent.com/70484406/181916290-d0d04e8b-4dea-4343-9b41-e3d81713b98e.png)
46+
47+
**Congrats You have successfully added a Sponsor Button to your Repository !! 🥳🚀**

‎pages/How-to/guide/archive-repo.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## How to archive a repository
2+
3+
### Step One :
4+
5+
- Go to [Github](https://github.com/login) and sign in to your account
6+
7+
- Go to repositories page and pick any of your project repository which you want to archive.
8+
9+
### Step Two :
10+
11+
- Under your repository name, click on Settings.
12+
<p align="center">
13+
<img src="https://user-images.githubusercontent.com/62974339/188816081-e6d54d90-6163-4414-ac55-0a72aacf69e6.png" alt=" image"/>
14+
</p>
15+
16+
### Step Three :
17+
18+
- Scroll down and you will see "Danger Zone".
19+
20+
<p align="center">
21+
<img src="https://user-images.githubusercontent.com/62974339/188816842-c1c516ca-ddba-4764-a332-4ad81ef9f3a8.png" alt=" image"/>
22+
</p>
23+
24+
### Step Four :
25+
26+
- Under "Danger Zone", click Archive this repository
27+
28+
<p align="center">
29+
<img src="https://user-images.githubusercontent.com/62974339/188817447-e7fcdb13-385c-4abc-a0e3-8a16e289b727.png" alt=" image"/>
30+
</p>
31+
32+
### Step Five :
33+
34+
- Now you will see a modal poping up
35+
36+
<p align="center">
37+
<img src="https://user-images.githubusercontent.com/62974339/188819763-c8db09ce-e0c0-4423-ad4e-cec326e52639.png" alt=" image"/>
38+
</p>
39+
40+
- Read the warnings and type the name of the repository you want to archive and click on the button.
41+
42+
<p align="center">
43+
<img src="https://user-images.githubusercontent.com/62974339/188819936-7ab2642e-2e07-453b-b9ba-295aa2c45bed.png" alt=" image"/>
44+
</p>
45+
46+
- Once you click on the button , you will see a message .
47+
48+
<p align="center">
49+
<img src="https://user-images.githubusercontent.com/62974339/188820584-40ce2094-63ec-49a0-ad0b-c76e4bc99193.png" alt=" image"/>
50+
</p>
51+
52+
#### Congratulations! You have successfully learned how to archive a repository🚀

0 commit comments

Comments
 (0)