Skip to content

Commit 0e0f09c

Browse files
authored
Merge branch 'GitMetricsLab:main' into feat/signin-with-github
2 parents 7ef7d82 + 9d615a7 commit 0e0f09c

2 files changed

Lines changed: 181 additions & 0 deletions

File tree

CODE_OF_CODUCT.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Code of Conduct
2+
3+
## 1. Purpose
4+
We aim to create an open and welcoming environment where contributors from all backgrounds feel valued and respected.
5+
This code of conduct outlines expectations for behavior to ensure everyone can contribute in a harassment-free environment.
6+
7+
## 2. Scope
8+
This Code of Conduct applies to all contributors, including maintainers and users. It applies to both project spaces and public spaces where an individual represents the project.
9+
10+
## 3. Our Standards
11+
In a welcoming environment, contributors should:
12+
13+
Be kind and respectful to others.
14+
Collaborate with others in a constructive manner.
15+
Provide feedback in a respectful and considerate way.
16+
Be open to differing viewpoints and experiences.
17+
Show empathy and understanding towards others.
18+
Unacceptable behaviors include, but are not limited to:
19+
20+
Use of derogatory comments, insults, or personal attacks.
21+
Harassment of any kind, including but not limited to: offensive comments related to gender, race, religion, or any other personal characteristics.
22+
The publication of private information without consent.
23+
Any behavior that could be perceived as discriminatory, intimidating, or threatening.
24+
25+
## 4. Enforcement
26+
Instances of unacceptable behavior may be reported to the project team. All complaints will be reviewed and investigated and will result in appropriate action.
27+
28+
## 5. Acknowledgment
29+
By contributing to Scribbie, you agree to adhere to this Code of Conduct and help create a safe, productive, and inclusive environment for all.

CONTRIBUTING.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# 🌟 Contributing to GitHub Tracker
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!
5+
6+
<br>
7+
8+
## 🧑‍⚖️ Code of Conduct
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.
11+
12+
<br>
13+
14+
## ⭐ Star the Repository
15+
16+
Show your support by starring our repository:
17+
18+
<p align="center">
19+
<a href="https://github.com/GitMetricsLab/github_tracker">
20+
<img alt="Stars" src="https://img.shields.io/github/stars/GitMetricsLab/github_tracker?style=for-the-badge&logo=github"/>
21+
</a>
22+
</p>
23+
24+
---
25+
26+
## 🛠 Project Structure
27+
28+
```bash
29+
github_tracker/
30+
├── backend/ # Node.js + Express backend
31+
│ ├── routes/ # API routes
32+
│ ├── controllers/ # Logic handlers
33+
│ └── index.js # Entry point for server
34+
35+
├── frontend/ # React + Vite frontend
36+
│ ├── components/ # Reusable UI components
37+
│ ├── pages/ # Main pages/routes
38+
│ └── main.jsx # Root file
39+
40+
├── public/ # Static assets like images
41+
42+
├── .gitignore
43+
├── README.md
44+
├── package.json
45+
├── tailwind.config.js
46+
└── CONTRIBUTING.md
47+
```
48+
49+
---
50+
51+
## 🤝 How to Contribute
52+
53+
### 🧭 First-Time Contribution Steps
54+
55+
1. **Star the Repository**
56+
Click the "Star" button on the top right of this page.
57+
58+
2. **Fork the Repository** 🍴
59+
Click "Fork" to create your own copy under your GitHub account.
60+
61+
3. **Clone Your Fork** 📥
62+
```bash
63+
git clone https://github.com/<your-username>/github_tracker.git
64+
```
65+
66+
4. **Navigate to the Project Folder** 📁
67+
```bash
68+
cd github_tracker
69+
```
70+
71+
5. **Create a New Branch** 🌿
72+
```bash
73+
git checkout -b your-feature-name
74+
```
75+
76+
6. **Make Your Changes**
77+
After modifying files, stage and commit:
78+
79+
```bash
80+
git add .
81+
git commit -m "✨ Added [feature/fix]: your message"
82+
```
83+
84+
7. **Push Your Branch to GitHub** 🚀
85+
```bash
86+
git push origin your-feature-name
87+
```
88+
89+
8. **Open a Pull Request** 🔁
90+
Go to the original repo and click **Compare & pull request**.
91+
92+
9. **Celebrate!** 🎉
93+
You’ve just submitted your first contribution!
94+
95+
---
96+
97+
## 🚦 Pull Request Guidelines
98+
99+
- ✅ Ensure your code builds and runs without errors.
100+
- 🧪 Include tests where applicable.
101+
- 💬 Add comments if the logic is non-trivial.
102+
- 📸 Attach screenshots for UI-related changes.
103+
- 🔖 Use meaningful commit messages and titles.
104+
105+
---
106+
107+
## 🐞 Reporting Issues
108+
109+
If you discover a bug or have a suggestion:
110+
111+
➡️ [Open an Issue](https://github.com/GitMetricsLab/github_tracker/issues/new/choose)
112+
113+
Please include:
114+
115+
- **Steps to Reproduce**
116+
- **Expected vs. Actual Behavior**
117+
- **Screenshots/Logs (if any)**
118+
119+
---
120+
121+
## 🧠 Good Coding Practices
122+
123+
1. **Consistent Style**
124+
Stick to the project's linting and formatting conventions (e.g., ESLint, Prettier, Tailwind classes).
125+
126+
2. **Meaningful Naming**
127+
Use self-explanatory names for variables and functions.
128+
129+
3. **Avoid Duplication**
130+
Keep your code DRY (Don't Repeat Yourself).
131+
132+
4. **Testing**
133+
Add unit or integration tests for any new logic.
134+
135+
5. **Review Others’ PRs**
136+
Help others by reviewing their PRs too!
137+
138+
---
139+
140+
## 📜 Coding Standards
141+
142+
- Follow our [Coding Standards](https://github.com/GitMetricsLab/github_tracker/CODING_STANDARDS.md) document.
143+
- Commit messages should be clear and use prefixes like `fix:`, `feat:`, `chore:`, `refactor:`.
144+
145+
---
146+
147+
## 🙌 Thank You!
148+
149+
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.
150+
151+
**Happy Coding!** 💻🚀
152+
**— GitHub Tracker Team**

0 commit comments

Comments
 (0)