|
| 1 | +--- |
| 2 | +name: "📝 How to Contribute & Create Issues for SSOC S4" |
| 3 | +about: "Step-by-step guide for contributors to help with UniPath during Social Summer of Code Season 4" |
| 4 | +title: "How to Contribute and Create Issues for UniPath | SSOC S4" |
| 5 | +labels: "documentation, help wanted" |
| 6 | +assignees: "" |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +# 👋 Welcome to UniPath Contributors! |
| 11 | + |
| 12 | +Thank you for joining the **UniPath** project and being part of **Social Summer of Code Season 4 (SSOC S4)**! |
| 13 | +This guide will help you understand **how to contribute** and **how to create or pick issues** to work on easily. |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## 🔍 What is UniPath? |
| 18 | + |
| 19 | +UniPath is an AI-powered career coach platform that helps users build resumes, get job recommendations, prepare for interviews, and explore career insights — all powered by AI! |
| 20 | + |
| 21 | +Your contributions will help us build new features, fix bugs, improve UI/UX, and make the platform better for everyone. |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +## 🛠️ How to Contribute? |
| 26 | + |
| 27 | +### 1. Fork & Clone the Repository |
| 28 | + |
| 29 | +- Fork the [UniPath GitHub repo](https://github.com/amitkumardemo/UniPath) to your own GitHub account. |
| 30 | +- Clone your fork locally: |
| 31 | +-[git clone](https://github.com/your-username/UniPath.git) |
| 32 | + |
| 33 | + |
| 34 | +### 2. Create a New Branch |
| 35 | + |
| 36 | +- Always create a new branch for your work: |
| 37 | + |
| 38 | +### 3. Work on Your Task |
| 39 | + |
| 40 | +- Build features, fix bugs, or improve documentation. |
| 41 | +- Commit your changes with clear, professional commit messages. |
| 42 | + |
| 43 | +### 4. Push & Make a Pull Request (PR) |
| 44 | + |
| 45 | +- Push your branch: |
| 46 | + |
| 47 | +- Go to the original repo and create a **Pull Request** from your branch. |
| 48 | +- In your PR description, explain what you did and why. |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## 📝 How to Create Issues? |
| 53 | + |
| 54 | +If you want to add new tasks or improvements, follow these steps: |
| 55 | + |
| 56 | +1. **Write a clear title and description** of the issue. |
| 57 | +2. Decide the **difficulty level** and add one of these labels: |
| 58 | + - 🔰 `Beginner` — for easy tasks, great if you're just starting. |
| 59 | + - ⚙️ `Intermediate` — moderate difficulty, for those with some experience. |
| 60 | + - 🚀 `Advanced` — challenging tasks, for experienced contributors. |
| 61 | +3. Add the label **`SSOC S4`** to show it’s part of the Social Summer of Code Season 4. |
| 62 | +4. Include any helpful links, screenshots, or references to help others understand and start quickly. |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +## 🎯 How to Pick Issues to Work On? |
| 67 | + |
| 68 | +- Browse issues labeled **`Beginner`**, **`Intermediate`**, or **`Advanced`** based on your skill level. |
| 69 | +- Look for the **`SSOC S4`** label to find tasks eligible for the program. |
| 70 | +- Comment on the issue if you want to work on it or need help. |
| 71 | +- Once assigned or approved, start working and follow the contribution steps above. |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +## 💡 Tips for Smooth Contribution |
| 76 | + |
| 77 | +- Always sync your fork before starting new work: |
| 78 | +- Ask questions if you’re stuck — maintainers and PAs are happy to help! |
| 79 | +- Keep your commits clean and descriptive. |
| 80 | +- Follow the project's coding style and guidelines. |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +## 📅 Important Dates |
| 85 | + |
| 86 | +- Contribution period starts: **14th June** |
| 87 | +- Make sure to complete and submit your PRs within the SSOC S4 timeline. |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +Thanks for contributing to **UniPath**! Your help is valuable in building a powerful AI career platform for everyone. |
| 92 | +Happy coding! 💙 |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +*— UniPath Team 🚀* |
| 97 | +Amit Kumar Project Admin |
0 commit comments