Skip to content

Commit a7d6ff4

Browse files
Merge pull request #132 from avinash201199/revert-130-revert-122-update
Revert "Revert "Title: Add contribution templates and update CONTRIBUTING.md Body :Ad…""
2 parents d20b50f + 9adacff commit a7d6ff4

File tree

4 files changed

+122
-7
lines changed

4 files changed

+122
-7
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us fix a bug
4+
title: "Bug: "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '...'
16+
3. Scroll down to '...'
17+
4. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Desktop (please complete the following information):**
26+
- OS: [e.g. Windows 10]
27+
- Browser [e.g. chrome, safari]
28+
- Version [e.g. 22]
29+
30+
**Additional context**
31+
Add any other context about the problem here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "Feature: "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Thank you for your contribution! Please fill out the form below to help maintainers review your PR quickly.
3+
-->
4+
5+
## Summary
6+
Short description of the change and why it is needed.
7+
8+
## Related Issue
9+
Resolves: # (if applicable)
10+
11+
## Type of change
12+
- [ ] Bug fix
13+
- [ ] New feature
14+
- [ ] Documentation update
15+
- [ ] Other (please describe):
16+
17+
## Checklist
18+
- [ ] My code follows the repository style
19+
- [ ] I have added necessary documentation (if appropriate)
20+
- [ ] I have added tests (if appropriate)
21+
- [ ] I have read the contributing guidelines
22+
23+
## How to test
24+
Steps to reproduce or verify this change. Include relevant commands and expected output.
25+
26+
## Screenshots (if applicable)
27+
Add screenshots to demonstrate the change.
28+
29+
## Additional notes
30+
Anything else the reviewer should know.

CONTRIBUTING.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,55 @@
11
# Contributing
22

3-
Thanks for your interest in contributing! Basic workflow:
3+
Thanks for your interest in contributing! We welcome first-time contributors and maintain a friendly, beginner-focused workflow.
44

5-
- Fork the repo, create a branch, make changes, open a PR.
5+
## Basic workflow
66

7-
Previewing the website locally:
7+
- Fork the repo
8+
- Create a topic branch (git checkout -b feature/your-feature)
9+
- Make changes, commit, push to your fork
10+
- Open a Pull Request (PR)
811

9-
1. From the repository root run:
12+
We have templates to help: issue templates and a PR template are available in `.github/`.
13+
14+
## Previewing the website locally
15+
16+
You can preview the static site using a simple HTTP server. Below are cross-platform instructions.
17+
18+
Windows (PowerShell):
19+
20+
```powershell
21+
# From repository root
22+
python -m http.server 8000
23+
# or, if python is python3 on your system:
24+
python3 -m http.server 8000
25+
```
26+
27+
macOS / Linux:
1028

1129
```bash
1230
python3 -m http.server 8000
1331
```
1432

15-
2. Open http://localhost:8000/index.html
33+
Then open http://localhost:8000/index.html in your browser.
1634

17-
Website deployment branch:
35+
## PR Checklist
36+
37+
Before submitting a PR, please make sure:
38+
39+
- [ ] Your PR has a clear title and description explaining the change
40+
- [ ] You followed the coding / formatting style used in the repo
41+
- [ ] You updated documentation or README if required
42+
- [ ] You created or updated tests where appropriate (small projects may not have tests)
43+
- [ ] You linked any related issue (use the issue templates to open new ones)
44+
45+
## Website deployment branch
1846

1947
- A branch named `website-pages` is used to host the static site for GitHub Pages. You can create a PR from this branch to `main` or configure Pages to publish from it directly.
20-
- To preview the site from that branch locally, check out the branch and run the simple HTTP server.
48+
- To preview the site from that branch locally, check out the branch and run the simple HTTP server as shown above.
49+
50+
## Community and code of conduct
51+
52+
Please follow the project's `CODE_OF_CONDUCT.md`.
53+
54+
If you are unsure about a change, open an issue first or join the community WhatsApp linked in the README.
55+

0 commit comments

Comments
 (0)