Skip to content

Commit bacd2c7

Browse files
[PLT-29] Improve Contributing Docs (#1100)
* update: contribution-guidelines * redefined: issue-templates * restructure: pr-template * update: project/tech-stacks * added clone warning & new category in project request * fixes: grammetical errors & improve: clarity
1 parent 46cdf11 commit bacd2c7

File tree

7 files changed

+155
-93
lines changed

7 files changed

+155
-93
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ body:
1616
attributes:
1717
label: "Important Points to Note"
1818
options:
19-
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CODE_OF_CONDUCT.md)."
19+
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CODE_OF_CONDUCT.md)."
2020
required: true
21-
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CONTRIBUTING.md)."
21+
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CONTRIBUTING.md)."
2222
required: true
2323
- label: "I have checked the existing issues and can confirm that this is not a duplicate."
2424
required: true
25-
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/issues/108)."
25+
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/blog-script/issues/108)."
2626
required: true
2727

2828
- type: textarea
@@ -40,7 +40,7 @@ body:
4040
label: "Is this bug related to the main website or any sub-projects?"
4141
options:
4242
- "Main Website"
43-
- "Sub Project"
43+
- "Sub Module/Project"
4444
validations:
4545
required: true
4646

@@ -100,5 +100,5 @@ body:
100100
**Do not raise a PR without being assigned to the issue.**
101101
> **NOTE:** This issue will automatically be unassigned if the PR is not raised within the given time frame.
102102
103-
### Happy Coding! 🎉
103+
#### Happy Coding! 🎉
104104
All the best with your contribution! 🚀

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ contact_links:
44
url: https://discord.gg/tSqtvHUJzE
55
about: You can join the discussions on Discord.
66
- name: Chat
7-
url: https://github.com/Avdhesh-Varshney/WebMasterLog/discussions
7+
url: https://github.com/Avdhesh-Varshney/blog-script/discussions
88
about: You can chat with the community on GitHub Discussions.
99
- name: Login does not work
10-
url: https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CONTRIBUTING.md
10+
url: https://github.com/Avdhesh-Varshney/blog-script/blob/main/CONTRIBUTING.md
1111
about: Before opening a new issue, please make sure to read CONTRIBUTING.md

.github/ISSUE_TEMPLATE/enhancement-request.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ body:
1616
attributes:
1717
label: "Important Points to Note"
1818
options:
19-
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CODE_OF_CONDUCT.md)."
19+
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CODE_OF_CONDUCT.md)."
2020
required: true
21-
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CONTRIBUTING.md)."
21+
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CONTRIBUTING.md)."
2222
required: true
2323
- label: "I have checked the existing issues and can confirm that this is not a duplicate."
2424
required: true
25-
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/issues/108)."
25+
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/blog-script/issues/108)."
2626
required: true
2727

2828
- type: dropdown
@@ -31,11 +31,13 @@ body:
3131
label: "Category"
3232
description: "Select the category that best describes the enhancement."
3333
options:
34+
- "Feature Addition"
35+
- "Code Refactoring"
3436
- "Documentation"
3537
- "Styling"
36-
- "Code Refactoring"
37-
- "Feature Addition"
3838
- "Other"
39+
validations:
40+
required: true
3941

4042
- type: textarea
4143
id: enhancement-description
@@ -100,5 +102,5 @@ body:
100102
**Do not raise a PR without being assigned to the issue.**
101103
> **NOTE:** This issue will automatically be unassigned if the PR is not raised within the given time frame.
102104
103-
### Happy Coding! 🎉
105+
#### Happy Coding! 🎉
104106
All the best with your contribution! 🚀

.github/ISSUE_TEMPLATE/project-request.yml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ body:
1313
attributes:
1414
label: "Important Points to Note"
1515
options:
16-
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CODE_OF_CONDUCT.md)."
16+
- label: "I agree to adhere to the project's [Code of Conduct](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CODE_OF_CONDUCT.md)."
1717
required: true
18-
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/blob/main/CONTRIBUTING.md)."
18+
- label: "I have reviewed and understood the project's [Contributing Guidelines](https://github.com/Avdhesh-Varshney/blog-script/blob/main/CONTRIBUTING.md)."
1919
required: true
2020
- label: "I have checked the existing issues and can confirm that this is not a duplicate."
2121
required: true
22-
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/WebMasterLog/issues/108)."
22+
- label: "I have reviewed and understood the project's [Issue Creation Guidelines](https://github.com/Avdhesh-Varshney/blog-script/issues/108)."
2323
required: true
2424

2525
- type: textarea
@@ -44,14 +44,10 @@ body:
4444
label: "Project Category"
4545
description: "Select the appropriate category for the project."
4646
options:
47-
- "Angular JS"
48-
- "HTML/CSS"
49-
- "Next JS"
50-
- "Node JS"
51-
- "React JS"
52-
- "Typescript"
53-
- "HTML/CSS/JS"
54-
- "Vue JS"
47+
- "data-science"
48+
- "web-development"
49+
- "main-website"
50+
- "documentation"
5551
validations:
5652
required: true
5753

@@ -111,5 +107,5 @@ body:
111107
**Do not raise a PR without being assigned to the issue.**
112108
> **NOTE:** This issue will automatically be unassigned if the PR is not raised within the given time frame.
113109
114-
### Happy Coding! 🎉
110+
#### Happy Coding! 🎉
115111
All the best with your contribution! 🚀

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
Closes: <!-- #issue-number -->
2-
3-
- **Issue Title:**
4-
- **Your Name:**
5-
- **Your Role:** <!-- Mention your role (like GSSOC, SSOC, JWOC, etc. Contributor) -->
1+
<!-- #issue_number -->
2+
Closes:
63

74
### Describe the add-ons or changes you've made 📃
85

@@ -17,15 +14,15 @@ Closes: <!-- #issue-number -->
1714
<!-- Please delete options that are not relevant. -->
1815
What sort of change have you made:
1916

20-
<!--
21-
Example how to mark a checkbox:-
22-
- [x] My code follows the code style of this project.
23-
-->
2417
- [ ] Bug fix
2518
- [ ] New feature
2619
- [ ] Code style update (formatting, local variables)
2720
- [ ] Documentation update
2821
- [ ] Database update
22+
<!--
23+
Example how to mark a checkbox:-
24+
- [x] My code follows the code style of this project.
25+
-->
2926

3027
### Note to reviewers 📄
3128
<!-- Add notes to reviewers if applicable -->

CONTRIBUTING.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,70 @@
11
<h1 align="center">Contributors Guide⚡ </h1>
22
<h3 align="center">Welcome to our open-source project! 😍<br> We appreciate your interest in contributing.😊 <br>This guide will help you get started with the project and make your first contribution.</h3>
33

4-
![Line](https://github.com/Avdhesh-Varshney/WebMasterLog/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
4+
![Line](https://github.com/Avdhesh-Varshney/blog-script/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
55

66
<h1 align="center">Creating first Pull Request 🌟</h1>
77

8-
---
98
1. Star this repository.
109
2. Fork this repository.
10+
1111
3. Clone the forked repository.
12+
13+
> ***WARNING***: **Avoid cloning with GitHub Desktop or GitKraken; it downloads all submodules, consuming excessive data.**
14+
1215
```css
13-
git clone https://github.com/<your-github-username>/WebMasterLog.git
16+
git clone https://github.com/<your-github-username>/blog-script.git
1417
```
1518

1619
4. Navigate to the project directory.
20+
1721
```py
18-
cd WebMasterLog
22+
cd blog-script
1923
```
24+
2025
5. Create a new branch.
26+
2127
```css
2228
git checkout -b <your_branch_name>
2329
```
30+
2431
6. Make changes.
25-
7. Stage your changes and commit
32+
2633
```css
2734
git add .
35+
```
36+
37+
7. Stage your changes and commit
38+
39+
```css
2840
git commit -m "<your_commit_message>"
2941
```
42+
3043
8. Push your local commits to the remote repo.
44+
3145
```css
3246
git push -u origin <your_branch_name>
3347
```
48+
3449
9. Create a Pull Request.
50+
3551
10. Congratulations! 🎉 you've made your contribution.
3652

3753

38-
![Line](https://github.com/Avdhesh-Varshney/WebMasterLog/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
54+
![Line](https://github.com/Avdhesh-Varshney/blog-script/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
3955

4056

41-
## :zap: Communication and Support 💬
57+
### :zap: Communication and Support 💬
4258
- Join the project's communication channels to interact with other contributors and seek assistance.
4359
- If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue.
4460

45-
## :zap: Code of Conduct 😇
61+
### :zap: Code of Conduct 😇
4662
Please follow our project's code of conduct while contributing.</br>Treat all contributors and users with respect and create a positive and inclusive environment for everyone.
4763

48-
## :zap: License 📄
64+
### :zap: License 📄
4965
The project is licensed under ***MIT***. Make sure to review and comply with the license terms.</br>We hope this guide helps you get started with contributing to our open-source project. Thank you for your contribution!
5066

51-
## :zap: Need more help?🤔
67+
### :zap: Need more help?🤔
5268

5369
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
5470

@@ -59,10 +75,10 @@ You can refer to the following articles on basics of Git and Github and also con
5975
- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
6076

6177

62-
![Line](https://github.com/Avdhesh-Varshney/WebMasterLog/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
78+
![Line](https://github.com/Avdhesh-Varshney/blog-script/assets/114330097/4b78510f-a941-45f8-a9d5-80ed0705e847)
6379

6480

65-
## :zap: Note from Admin ❗
81+
### :zap: Note from Admin ❗
6682

6783
- We welcome contributions from everyone. However, please avoid spamming the repository with irrelevant issues & pull requests. We reserve the right to mark PRs as invalid if they are not relevant.
6884

0 commit comments

Comments
 (0)