Skip to content

Commit 539b497

Browse files
committed
Update pull request template and README for improved contribution guidelines and clarity
1 parent 70d5aa6 commit 539b497

2 files changed

Lines changed: 95 additions & 39 deletions

File tree

.github/pull_request_template.md

Lines changed: 72 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,79 @@
11
## Summary
2-
Briefly describe the changes. Link related issues (e.g., Closes #123).
2+
<!-- Briefly describe what this PR does and why -->
33

4-
## Type of change
5-
- [ ] Bug fix
6-
- [ ] New feature
7-
- [ ] Refactor/Chore
8-
- [ ] Documentation
4+
**What**: Brief description of the changes
5+
**Why**: The problem this solves or feature this adds
6+
**Linked Issues**: Closes #[issue_number] | Fixes #[issue_number] | Related to #[issue_number]
7+
8+
## Type of Change
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Refactor (code change that neither fixes a bug nor adds a feature)
13+
- [ ] Documentation (changes to README, guides, comments)
14+
- [ ] Tests (adding missing tests or correcting existing tests)
15+
- [ ] Performance improvement
916

1017
## Screenshots (if UI changes)
18+
<!-- Include before/after screenshots for UI changes -->
19+
20+
| Before | After |
21+
|--------|-------|
22+
| Screenshot | Screenshot |
23+
24+
## Testing Instructions
25+
### For Reviewers:
26+
1. **Backend Setup** (if applicable):
27+
```bash
28+
cd backend
29+
npm install
30+
npm run dev
31+
```
1132

12-
## How to test
13-
- Steps to verify the change locally
14-
- Any API endpoints impacted
33+
2. **Extension Setup** (if applicable):
34+
- Open `chrome://extensions`
35+
- Enable Developer Mode
36+
- Load unpacked extension from `/extension` folder
37+
38+
3. **Test Steps**:
39+
- [ ] Step 1: ...
40+
- [ ] Step 2: ...
41+
- [ ] Step 3: ...
42+
43+
### Tested Environments:
44+
- [ ] Chrome (Version: ___)
45+
- [ ] Windows/Mac/Linux
46+
- [ ] Backend API (if applicable)
1547

1648
## Checklist
17-
- [ ] I read the CONTRIBUTING.md and followed the guidelines
18-
- [ ] I ran the backend locally for API changes (`npm run dev` in `backend/`)
19-
- [ ] I tested the extension locally (Load Unpacked) for UI changes
20-
- [ ] I added/updated documentation where needed
21-
- [ ] I added labels (e.g., `hacktoberfest`, `good first issue`) if applicable
22-
23-
## Hacktoberfest
24-
If this is for Hacktoberfest, maintainers can mark this PR as:
25-
- merge, or
26-
- approve the review, or
27-
- add the `hacktoberfest-accepted` label
49+
### General
50+
- [ ] I read and followed [CONTRIBUTING.md](../CONTRIBUTING.md)
51+
- [ ] I tested my changes thoroughly
52+
- [ ] I updated documentation where needed
53+
54+
### Code Quality
55+
- [ ] Code follows existing style conventions
56+
- [ ] Added comments for complex logic
57+
- [ ] No commented-out code left behind
58+
- [ ] No unnecessary dependencies added
59+
60+
### Functionality
61+
- [ ] Changes work as expected
62+
- [ ] No existing functionality is broken
63+
- [ ] Error handling is appropriate
64+
- [ ] Performance impact considered
65+
66+
### Project Specific
67+
- [ ] Extension loads without errors (if applicable)
68+
- [ ] Backend API works correctly (if applicable)
69+
- [ ] UI follows existing theme system (if applicable)
70+
71+
## Additional Notes
72+
<!-- Any additional context, concerns, or notes for reviewers -->
73+
74+
**Questions for Reviewers**:
75+
- Any specific areas you'd like extra attention on?
76+
77+
**Breaking Changes**: [List any breaking changes and migration steps]
78+
79+
**Future Work**: [Any follow-up work needed?]

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
[![Chrome Web Store](https://img.shields.io/badge/Chrome%20Web%20Store-Available-brightgreen?logo=googlechrome)](https://chromewebstore.google.com/detail/timemachine/hjkicompionnablkpkgnplnacnnchjij)
2020
[![Version](https://img.shields.io/badge/version-1.6.0-blue.svg)](CHANGELOG.md)
2121
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
22+
[![Contributors](https://img.shields.io/github/contributors/Harshdev625/TimeMachine)](https://github.com/Harshdev625/TimeMachine/graphs/contributors)
2223
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
2324
[![Hacktoberfest](https://img.shields.io/badge/Hacktoberfest-2025-orange)](https://hacktoberfest.com/)
2425

25-
[Getting Started](#quick-start) [Features](#features) [Documentation](#documentation) [Contributing](CONTRIBUTING.md) [Changelog](CHANGELOG.md)
26+
[Overview](#📖-overview) [Features](#✨-features) [Quick Start](#🚀-quick-start)[Tech Stack](#🛠️-tech-stack)[Contributing](#🤝-contributing)[Contributors](#👥-contributors)
2627

2728
</div>
2829

@@ -390,27 +391,32 @@ Configure automated email reports using EmailJS:
390391

391392
## 🤝 Contributing
392393

393-
We welcome contributions from the community! TimeMachine is open-source and thrives on collaboration.
394+
We welcome contributions from the community! Here's how you can help make TimeMachine better:
394395

395-
### 📝 How to Contribute
396-
397-
1. **Fork the repository**
398-
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
399-
3. **Make your changes**
400-
- Follow existing code style
401-
- Add comments for complex logic
402-
- Test thoroughly
403-
4. **Commit your changes** (`git commit -m 'Add amazing feature'`)
404-
5. **Push to branch** (`git push origin feature/amazing-feature`)
405-
6. **Open a Pull Request**
406-
407-
### 📋 Contribution Guidelines
396+
### 🚀 Quick Start
397+
1. Fork the repository
398+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
399+
3. Make your changes and test thoroughly
400+
4. Commit your changes (`git commit -m 'Add amazing feature'`)
401+
5. Push to the branch (`git push origin feature/amazing-feature`)
402+
6. Open a Pull Request
408403

404+
### 📋 Guidelines
409405
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines
410406
- Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
411407
- Check existing issues before creating new ones
412408
- Include screenshots for UI changes
413-
- Update documentation as needed
409+
- Test your changes locally
410+
411+
### 🎯 Ways to Contribute
412+
- 🐛 **Bug fixes** - Help us squash bugs
413+
-**New features** - Add cool functionality
414+
- 📚 **Documentation** - Improve guides and docs
415+
- 🎨 **UI/UX** - Make it more beautiful and user-friendly
416+
- 🧪 **Testing** - Help us maintain quality
417+
418+
### 🎃 Hacktoberfest
419+
We're participating in Hacktoberfest 2025! Look for issues labeled `hacktoberfest` and join the fun.
414420

415421
## 🔒 Security
416422

@@ -458,10 +464,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
458464

459465
## 👥 Contributors
460466

461-
Thanks to all the amazing people who have contributed to TimeMachine! 🎉
462-
463467
<a href="https://github.com/Harshdev625/TimeMachine/graphs/contributors">
464-
<img src="https://contrib.rocks/image?repo=Harshdev625/TimeMachine" />
468+
<img src="https://contrib.rocks/image?repo=Harshdev625/TimeMachine" alt="Contributors" />
465469
</a>
466470

467471
---

0 commit comments

Comments
 (0)