-
Notifications
You must be signed in to change notification settings - Fork 14
Add My Profile #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
juned-mansuri
wants to merge
1
commit into
sehmaluva:main
Choose a base branch
from
juned-mansuri:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add My Profile #27
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,296 +1,114 @@ | ||
| <!-- | ||
| 🎉 Thank you for contributing to Student Fest! | ||
|
|
||
| This template will guide you through creating a great pull request. | ||
| Fill out the sections below to help us review your contribution. | ||
|
|
||
| First time contributor? Welcome! 🌟 | ||
| Don't worry if you're not sure about something - we're here to help! | ||
| --> | ||
|
|
||
| ## 📋 Description | ||
|
|
||
| <!-- Provide a clear and concise description of your changes --> | ||
|
|
||
| ### What type of contribution is this? | ||
|
|
||
| <!-- Check all that apply by replacing [ ] with [x] --> | ||
|
|
||
| - [ ] 👤 Profile (Adding or updating a student profile) | ||
| - [ ] 🧩 Challenge (Solving a coding challenge) | ||
| - [ ] 🚀 Project (Building a new project or feature) | ||
| - [ ] 📜 Script (Adding a helpful script or tool) | ||
| - [ ] 📝 Documentation (Improving docs, README, or guides) | ||
| - [ ] 🐛 Bug Fix (Fixing an issue) | ||
| - [ ] ✨ Enhancement (Improving existing functionality) | ||
| - [ ] 🎨 Design (UI/UX improvements) | ||
|
|
||
| ### What does this PR do? | ||
|
|
||
| <!-- Describe your changes in detail. What problem does it solve? --> | ||
|
|
||
|
|
||
|
|
||
| ### Related Issue | ||
|
|
||
| <!-- Link to any related issue(s). Use "Closes #123" to auto-close an issue when merged --> | ||
|
|
||
| - Closes # | ||
| - Related to # | ||
|
|
||
| --- | ||
|
|
||
| ## 🎯 For Beginners: Step-by-Step Guide | ||
|
|
||
| <!-- If you're new to Git/GitHub, this section is for you! --> | ||
|
|
||
| ### Before Submitting | ||
|
|
||
| 1. **✅ I have tested my changes locally** | ||
| - Run your code to make sure it works | ||
| - Check for any errors or warnings | ||
|
|
||
| 2. **✅ I have followed the project guidelines** | ||
| - Read [CONTRIBUTING.md](../CONTRIBUTING.md) | ||
| - Followed coding standards and best practices | ||
|
|
||
| 3. **✅ I have updated documentation** (if needed) | ||
| - Updated README if adding new features | ||
| - Added comments to complex code | ||
| - Created/updated any relevant docs | ||
|
|
||
| ### Need Help? | ||
|
|
||
| - 💬 **Ask questions** in the comments below | ||
| - 📖 **Read the guides** in [docs/guides/](../docs/guides/) | ||
| - 🆘 **Tag a maintainer** with @mention if stuck | ||
| - 🎓 **Check our FAQ** for common issues | ||
|
|
||
| --- | ||
|
|
||
| ## 🧪 Testing | ||
|
|
||
| ### How to test this PR? | ||
|
|
||
| <!-- Describe the steps to test your changes --> | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ### Test Results | ||
|
|
||
| <!-- Paste any test output or screenshots showing your changes work --> | ||
|
|
||
| ``` | ||
| Paste test output here | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 📸 Screenshots / Demo | ||
|
|
||
| <!-- If your changes include visual elements, add screenshots or GIFs --> | ||
|
|
||
| ### Before | ||
| <!-- Screenshot or description of before your changes --> | ||
|
|
||
|
|
||
| ### After | ||
| <!-- Screenshot or description of after your changes --> | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## 📝 Checklist | ||
|
|
||
| <!-- Go through this checklist before submitting. Check items with [x] --> | ||
|
|
||
| ### Code Quality | ||
|
|
||
| - [ ] My code follows the project's style guidelines | ||
| - [ ] I have performed a self-review of my code | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] My changes generate no new warnings or errors | ||
| - [ ] I have checked for and fixed any typos | ||
|
|
||
| ### Documentation | ||
|
|
||
| - [ ] I have updated the README (if applicable) | ||
| - [ ] I have added/updated comments in my code | ||
| - [ ] I have updated relevant documentation in `/docs` | ||
| - [ ] My profile follows the template (for profile contributions) | ||
|
|
||
| ### Testing & Validation | ||
|
|
||
| # 🎉 Pull Request | ||
|
|
||
| ## 📝 Description | ||
| <!-- Provide a brief description of what this PR does --> | ||
|
|
||
|
|
||
| ## 🎯 Type of Contribution | ||
| <!-- Check all that apply by putting an 'x' in the boxes: [x] --> | ||
| - [ ] 👤 Student Profile (adding or updating profile) | ||
| - [ ] 🧩 Coding Challenge (solution or new challenge) | ||
| - [ ] 🚀 Project (new project or enhancement) | ||
| - [ ] 📜 Script/Tool (automation or utility) | ||
| - [ ] 📚 Documentation (guides, README, or comments) | ||
| - [ ] 🐛 Bug Fix | ||
| - [ ] ✨ New Feature | ||
| - [ ] 🎨 UI/Design Improvement | ||
| - [ ] ♻️ Code Refactoring | ||
| - [ ] 🔧 Configuration/Workflow Update | ||
|
|
||
| ## 🎓 Experience Level | ||
| <!-- Check the one that best describes you --> | ||
| - [ ] 🌱 First-time contributor (this is my first open source contribution) | ||
| - [ ] 🌿 Beginner (I've made a few contributions before) | ||
| - [ ] 🌳 Intermediate (I'm comfortable with Git and GitHub) | ||
| - [ ] 🌲 Advanced (I'm experienced with open source) | ||
|
|
||
| ## ✅ Pre-Submission Checklist | ||
| <!-- Make sure you've done these before submitting --> | ||
| - [ ] I have read the [Contributing Guidelines](../../docs/guides/CONTRIBUTING.md) | ||
| - [ ] My code follows the project's code style | ||
| - [ ] I have tested my changes locally | ||
| - [ ] I have added tests that prove my fix/feature works (if applicable) | ||
| - [ ] All existing tests pass with my changes | ||
| - [ ] I have checked that my changes don't break other features | ||
|
|
||
| ### Git & Commit | ||
|
|
||
| - [ ] My branch is up to date with the main branch | ||
| - [ ] I have used clear, descriptive commit messages | ||
| - [ ] I have squashed any unnecessary commits | ||
| - [ ] My PR title clearly describes what this PR does | ||
|
|
||
| --- | ||
|
|
||
| ## 🎓 For Different Contribution Types | ||
|
|
||
| <details> | ||
| <summary>📱 <b>Profile Contributions</b></summary> | ||
|
|
||
| ### Profile Checklist | ||
| - [ ] Used the profile template from `docs/templates/PROFILE_TEMPLATE.md` | ||
| - [ ] File is named `profiles/YOUR_GITHUB_USERNAME.md` | ||
| - [ ] Included your name, school, and interests | ||
| - [ ] Profile is professional and respectful | ||
| - [ ] No personal sensitive information included | ||
|
|
||
| ### Profile Tips | ||
| - ✅ Be authentic and showcase your personality | ||
| - ✅ Include your learning goals | ||
| - ✅ Mention technologies you're interested in | ||
| - ✅ Add a fun fact about yourself | ||
| - ❌ Don't include email, phone, or address | ||
| - ❌ Don't use offensive language | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>🧩 <b>Challenge Solutions</b></summary> | ||
|
|
||
| ### Challenge Checklist | ||
| - [ ] My solution is in the correct directory (`challenges/level/challenge-name/`) | ||
| - [ ] I have included clear comments explaining my approach | ||
| - [ ] My solution handles edge cases | ||
| - [ ] I have tested with different inputs | ||
| - [ ] My code follows the challenge requirements | ||
|
|
||
| ### Challenge Tips | ||
| - ✅ Explain your thought process in comments | ||
| - ✅ Consider time and space complexity | ||
| - ✅ Test with edge cases (empty inputs, large numbers, etc.) | ||
| - ✅ Write clean, readable code | ||
| - ❌ Don't just copy solutions from the internet | ||
| - ❌ Don't submit untested code | ||
| - [ ] I have added comments to my code where necessary | ||
| - [ ] My changes don't break existing functionality | ||
| - [ ] I have updated documentation if needed | ||
| - [ ] My commit messages are clear and descriptive | ||
|
|
||
| </details> | ||
| ## 🧪 Testing Done | ||
| <!-- Describe how you tested your changes --> | ||
| - [ ] Tested locally | ||
| - [ ] Added/updated tests | ||
| - [ ] Manual testing performed | ||
| - [ ] N/A (documentation only) | ||
|
|
||
| <details> | ||
| <summary>🚀 <b>Project Contributions</b></summary> | ||
| **Testing details:** | ||
| <!-- Describe what you tested and the results --> | ||
|
|
||
| ### Project Checklist | ||
| - [ ] Project has a clear README with setup instructions | ||
| - [ ] All dependencies are documented | ||
| - [ ] Code is organized and well-structured | ||
| - [ ] Project follows the directory structure guidelines | ||
| - [ ] Includes examples or demo (if applicable) | ||
|
|
||
| ### Project Tips | ||
| - ✅ Include a demo or screenshots | ||
| - ✅ Write clear setup/installation steps | ||
| - ✅ Add error handling | ||
| - ✅ Make it beginner-friendly | ||
| - ✅ Include a "How to Use" section | ||
| - ❌ Don't commit node_modules, .env, or build artifacts | ||
| - ❌ Don't include sensitive data or API keys | ||
| ## 📸 Screenshots (if applicable) | ||
| <!-- Add screenshots for UI changes or visual improvements --> | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>📝 <b>Documentation</b></summary> | ||
| ## 🔗 Related Issues | ||
| <!-- Link any related issues using #issue_number --> | ||
| Closes # | ||
| Related to # | ||
|
|
||
| ### Documentation Checklist | ||
| - [ ] Writing is clear and easy to understand | ||
| - [ ] Grammar and spelling are correct | ||
| - [ ] Links are working and relevant | ||
| - [ ] Examples are included where helpful | ||
| - [ ] Follows the project's documentation style | ||
| ## 📚 Additional Context | ||
| <!-- Add any other context, notes, or explanations about your PR --> | ||
|
|
||
| ### Documentation Tips | ||
| - ✅ Write for beginners | ||
| - ✅ Use examples to clarify complex topics | ||
| - ✅ Break content into sections with headers | ||
| - ✅ Include code blocks with proper syntax highlighting | ||
| - ❌ Don't assume prior knowledge | ||
| - ❌ Don't use overly technical jargon without explanation | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## 🌟 Additional Information | ||
|
|
||
| ### What I learned while working on this: | ||
|
|
||
| <!-- Share what you learned! This helps others and shows your growth --> | ||
|
|
||
|
|
||
|
|
||
| ### Challenges I faced: | ||
|
|
||
| <!-- What was difficult? How did you overcome it? --> | ||
|
|
||
| ## 💡 Learning Journey (Optional but Encouraged!) | ||
| <!-- Share what you learned while working on this! This helps other students --> | ||
| **What I learned:** | ||
|
|
||
|
|
||
| ### Questions for reviewers: | ||
| **Challenges I faced:** | ||
|
|
||
| <!-- Any specific areas you'd like feedback on? --> | ||
|
|
||
| **How I overcame them:** | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## 📚 Resources I Used | ||
| ## 🎓 First-Time Contributors: Welcome! 🎉 | ||
|
|
||
| <!-- List any tutorials, docs, or resources that helped you (optional but appreciated!) --> | ||
| If this is your first contribution, don't worry about getting everything perfect! Here's what happens next: | ||
|
|
||
| - | ||
| - | ||
| 1. **Automated Checks** ✓ | ||
| - Our CI will automatically test your code | ||
| - Don't panic if something fails - it's a learning opportunity! | ||
| - You can push more commits to fix any issues | ||
|
|
||
| --- | ||
| 2. **Code Review** 👀 | ||
| - A maintainer will review your contribution | ||
| - They might suggest some changes - this is normal and helpful! | ||
| - Feel free to ask questions if anything is unclear | ||
|
|
||
| ## 💬 Notes for Reviewers | ||
| 3. **Feedback Loop** 🔄 | ||
| - Make any requested changes | ||
| - Push new commits to this same PR | ||
| - The review process repeats until everything looks good | ||
|
|
||
| <!-- Anything specific you want reviewers to know or pay attention to? --> | ||
| 4. **Merge & Celebrate** 🎊 | ||
| - Once approved, your PR will be merged | ||
| - You'll earn contributor badges | ||
| - Your profile will appear in our contributors gallery! | ||
|
|
||
| **Need Help?** | ||
| - Comment on this PR with your questions | ||
| - Tag `@maintainers` for assistance | ||
| - Check our [FAQ](../../docs/guides/FAQ.md) | ||
| - Join our [Discussions](https://github.com/sehmaluva/student-fest/discussions) | ||
|
|
||
| **Remember:** Every expert was once a beginner. You're doing great! 💪 | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| ## 🚀 What Happens Next? | ||
|
|
||
| After you submit this PR: | ||
|
|
||
| 1. **Automated Checks** 🤖 | ||
| - CI/CD will run automated tests | ||
| - Linters will check code quality | ||
| - File structure will be validated | ||
|
|
||
| 2. **Review Process** 👀 | ||
| - A maintainer will review your PR | ||
| - You may receive feedback or change requests | ||
| - Don't worry - this is normal and helps everyone learn! | ||
|
|
||
| 3. **Merge & Recognition** 🎉 | ||
| - Once approved, your PR will be merged | ||
| - You'll be added to our contributors list | ||
| - You'll earn achievement badges | ||
|
|
||
| ### Timeline | ||
| ⏰ Most PRs are reviewed within 24-48 hours | ||
| ⏰ Complex PRs may take longer | ||
| ⏰ We're all volunteers, so please be patient! | ||
|
|
||
| ### Need Help? | ||
| If you don't get a response after 3 days, feel free to: | ||
| - Comment with a polite ping | ||
| - Tag @sehmaluva or another maintainer | ||
| - Ask in our community discussions | ||
|
|
||
| Thank you for contributing! 🙌 | ||
| --> | ||
| ### 📋 For Reviewers | ||
| <!-- This section is for maintainers --> | ||
| - [ ] Code quality is acceptable | ||
| - [ ] Tests pass or N/A | ||
| - [ ] Documentation is updated if needed | ||
| - [ ] No security concerns | ||
| - [ ] Ready to merge |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@juned-mansuri you don't need to change this file... The template is there by default when you create a pr in github