|
1 | | -# 🌟 Contributing to GitHub Tracker |
| 1 | + # 🌟 Contributing to GitHub Tracker |
2 | 2 |
|
3 | | -Thank you for showing interest in **GitHub Tracker**! 🚀 |
4 | | -Whether you're here to fix a bug, propose an enhancement, or add a new feature, we’re thrilled to welcome you aboard. Let’s build something awesome together! |
| 3 | + Thank you for showing interest in **GitHub Tracker**! 🚀 |
| 4 | + Whether you're here to fix a bug, propose an enhancement, or add a new feature, we’re thrilled to welcome you aboard. Let’s build something awesome together! |
5 | 5 |
|
6 | | -<br> |
| 6 | + <br> |
7 | 7 |
|
8 | | -## 🧑⚖️ Code of Conduct |
| 8 | + ## 🧑⚖️ Code of Conduct |
9 | 9 |
|
10 | | -Please make sure to read and adhere to our [Code of Conduct](https://github.com/GitMetricsLab/github_tracker/CODE_OF_CONDUCT.md) before contributing. We aim to foster a respectful and inclusive environment for everyone. |
| 10 | + Please make sure to read and adhere to our [Code of Conduct](https://github.com/GitMetricsLab/github_tracker/CODE_OF_CONDUCT.md) before contributing. We aim to foster a respectful and inclusive environment for everyone. |
11 | 11 |
|
12 | | -<br> |
| 12 | + <br> |
13 | 13 |
|
14 | | -## 🛠 Project Structure |
| 14 | + ## 🛠 Project Structure |
15 | 15 |
|
16 | | -```bash |
17 | | -github_tracker/ |
18 | | -├── backend/ # Node.js + Express backend |
19 | | -│ ├── routes/ # API routes |
20 | | -│ ├── controllers/ # Logic handlers |
21 | | -│ └── index.js # Entry point for server |
22 | | -│ |
23 | | -├── frontend/ # React + Vite frontend |
24 | | -│ ├── components/ # Reusable UI components |
25 | | -│ ├── pages/ # Main pages/routes |
26 | | -│ └── main.jsx # Root file |
27 | | -│ |
28 | | -├── public/ # Static assets like images |
29 | | -│ |
30 | | -├── .gitignore |
31 | | -├── README.md |
32 | | -├── package.json |
33 | | -├── tailwind.config.js |
34 | | -└── CONTRIBUTING.md |
35 | | -``` |
| 16 | + ```bash |
| 17 | + github_tracker/ |
| 18 | + ├── backend/ # Node.js + Express backend |
| 19 | + │ ├── routes/ # API routes |
| 20 | + │ ├── controllers/ # Logic handlers |
| 21 | + │ └── index.js # Entry point for server |
| 22 | + │ |
| 23 | + ├── frontend/ # React + Vite frontend |
| 24 | + │ ├── components/ # Reusable UI components |
| 25 | + │ ├── pages/ # Main pages/routes |
| 26 | + │ └── main.jsx # Root file |
| 27 | + │ |
| 28 | + ├── public/ # Static assets like images |
| 29 | + │ |
| 30 | + ├── .gitignore |
| 31 | + ├── README.md |
| 32 | + ├── package.json |
| 33 | + ├── tailwind.config.js |
| 34 | + └── CONTRIBUTING.md |
| 35 | + ``` |
36 | 36 |
|
37 | | ---- |
| 37 | + --- |
38 | 38 |
|
39 | | -## 🤝 How to Contribute |
| 39 | + ## 🤝 How to Contribute |
40 | 40 |
|
41 | | -### 🧭 First-Time Contribution Steps |
| 41 | + ### 🧭 First-Time Contribution Steps |
42 | 42 |
|
43 | | -1. **Fork the Repository** 🍴 |
44 | | - Click "Fork" to create your own copy under your GitHub account. |
| 43 | + 1. **Fork the Repository** 🍴 |
| 44 | + Click "Fork" to create your own copy under your GitHub account. |
45 | 45 |
|
46 | | -2. **Clone Your Fork** 📥 |
47 | | - ```bash |
48 | | - git clone https://github.com/<your-username>/github_tracker.git |
49 | | - ``` |
| 46 | + 2. **Clone Your Fork** 📥 |
| 47 | + ```bash |
| 48 | + git clone https://github.com/<your-username>/github_tracker.git |
| 49 | + ``` |
50 | 50 |
|
51 | | -3. **Navigate to the Project Folder** 📁 |
52 | | - ```bash |
53 | | - cd github_tracker |
54 | | - ``` |
| 51 | + 3. **Navigate to the Project Folder** 📁 |
| 52 | + ```bash |
| 53 | + cd github_tracker |
| 54 | + ``` |
55 | 55 |
|
56 | | -4. **Create a New Branch** 🌿 |
57 | | - ```bash |
58 | | - git checkout -b your-feature-name |
59 | | - ``` |
| 56 | + 4. **Create a New Branch** 🌿 |
| 57 | + ```bash |
| 58 | + git checkout -b your-feature-name |
| 59 | + ``` |
60 | 60 |
|
61 | | -5. **Make Your Changes** ✍ |
62 | | - After modifying files, stage and commit: |
| 61 | + 5. **Make Your Changes** ✍ |
| 62 | + After modifying files, stage and commit: |
63 | 63 |
|
64 | | - ```bash |
65 | | - git add . |
66 | | - git commit -m "✨ Added [feature/fix]: your message" |
67 | | - ``` |
| 64 | + ```bash |
| 65 | + git add . |
| 66 | + git commit -m "✨ Added [feature/fix]: your message" |
| 67 | + ``` |
68 | 68 |
|
69 | | -6. **Push Your Branch to GitHub** 🚀 |
70 | | - ```bash |
71 | | - git push origin your-feature-name |
72 | | - ``` |
| 69 | + 6. **Push Your Branch to GitHub** 🚀 |
| 70 | + ```bash |
| 71 | + git push origin your-feature-name |
| 72 | + ``` |
73 | 73 |
|
74 | | -7. **Open a Pull Request** 🔁 |
75 | | - Go to the original repo and click **Compare & pull request**. |
76 | | - |
77 | | ---- |
| 74 | + 7. **Open a Pull Request** 🔁 |
| 75 | + Go to the original repo and click **Compare & pull request**. |
| 76 | + |
| 77 | + --- |
78 | 78 |
|
79 | | -## 🚦 Pull Request Guidelines |
| 79 | + ## 🚦 Pull Request Guidelines |
80 | 80 |
|
81 | | -### **Split Big Changes into Multiple Commits** |
82 | | -- When making large or complex changes, break them into smaller, logical commits. |
83 | | -- Each commit should represent a single purpose or unit of change (e.g. refactoring, adding a feature, fixing a bug). |
84 | | ---- |
85 | | -- ✅ Ensure your code builds and runs without errors. |
86 | | -- 🧪 Include tests where applicable. |
87 | | -- 💬 Add comments if the logic is non-trivial. |
88 | | -- 📸 Attach screenshots for UI-related changes. |
89 | | -- 🔖 Use meaningful commit messages and titles. |
| 81 | + ### **Split Big Changes into Multiple Commits** |
| 82 | + - When making large or complex changes, break them into smaller, logical commits. |
| 83 | + - Each commit should represent a single purpose or unit of change (e.g. refactoring, adding a feature, fixing a bug). |
| 84 | + --- |
| 85 | + - ✅ Ensure your code builds and runs without errors. |
| 86 | + - 🧪 Include tests where applicable. |
| 87 | + - 💬 Add comments if the logic is non-trivial. |
| 88 | + - 📸 Attach screenshots for UI-related changes. |
| 89 | + - 🔖 Use meaningful commit messages and titles. |
90 | 90 |
|
91 | | ---- |
| 91 | + --- |
92 | 92 |
|
93 | | -## 🐞 Reporting Issues |
| 93 | + ## 🐞 Reporting Issues |
94 | 94 |
|
95 | | -If you discover a bug or have a suggestion: |
| 95 | + If you discover a bug or have a suggestion: |
96 | 96 |
|
97 | | -➡️ [Open an Issue](https://github.com/GitMetricsLab/github_tracker/issues/new/choose) |
| 97 | + ➡️ [Open an Issue](https://github.com/GitMetricsLab/github_tracker/issues/new/choose) |
98 | 98 |
|
99 | | -Please include: |
| 99 | + Please include: |
100 | 100 |
|
101 | | -- **Steps to Reproduce** |
102 | | -- **Expected vs. Actual Behavior** |
103 | | -- **Screenshots/Logs (if any)** |
| 101 | + - **Steps to Reproduce** |
| 102 | + - **Expected vs. Actual Behavior** |
| 103 | + - **Screenshots/Logs (if any)** |
104 | 104 |
|
105 | | ---- |
| 105 | + --- |
106 | 106 |
|
107 | | -## 🧠 Good Coding Practices |
| 107 | + ## 🧠 Good Coding Practices |
108 | 108 |
|
109 | | -1. **Consistent Style** |
110 | | - Stick to the project's linting and formatting conventions (e.g., ESLint, Prettier, Tailwind classes). |
| 109 | + 1. **Consistent Style** |
| 110 | + Stick to the project's linting and formatting conventions (e.g., ESLint, Prettier, Tailwind classes). |
111 | 111 |
|
112 | | -2. **Meaningful Naming** |
113 | | - Use self-explanatory names for variables and functions. |
| 112 | + 2. **Meaningful Naming** |
| 113 | + Use self-explanatory names for variables and functions. |
114 | 114 |
|
115 | | -3. **Avoid Duplication** |
116 | | - Keep your code DRY (Don't Repeat Yourself). |
| 115 | + 3. **Avoid Duplication** |
| 116 | + Keep your code DRY (Don't Repeat Yourself). |
117 | 117 |
|
118 | | -4. **Testing** |
119 | | - Add unit or integration tests for any new logic. |
| 118 | + 4. **Testing** |
| 119 | + Add unit or integration tests for any new logic. |
120 | 120 |
|
121 | | -5. **Review Others’ PRs** |
122 | | - Help others by reviewing their PRs too! |
| 121 | + 5. **Review Others’ PRs** |
| 122 | + Help others by reviewing their PRs too! |
123 | 123 |
|
124 | | ---- |
| 124 | + --- |
125 | 125 |
|
126 | | -## 🙌 Thank You! |
| 126 | + ## 🙌 Thank You! |
127 | 127 |
|
128 | | -We’re so glad you’re here. Your time and effort are deeply appreciated. Feel free to reach out via Issues or Discussions if you need any help. |
| 128 | + We’re so glad you’re here. Your time and effort are deeply appreciated. Feel free to reach out via Issues or Discussions if you need any help. |
129 | 129 |
|
130 | | -**Happy Coding!** 💻🚀 |
| 130 | + **Happy Coding!** 💻🚀 |
0 commit comments