Skip to content

Commit bdd9cc3

Browse files
committed
intail version for prdouction
1 parent 0d768a8 commit bdd9cc3

19 files changed

Lines changed: 1063 additions & 4 deletions
Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
2+
# Contributing to Gecian Hub
3+
4+
Thank you for your interest in contributing to **Gecian Hub** πŸŽ‰
5+
This guide will help you contribute effectively β€” whether you're a beginner or experienced developer.
6+
7+
---
8+
9+
## 🧠 Before You Start
10+
11+
Please make sure you:
12+
- Read the README of the repository
13+
- Understand the project goal
14+
- Follow the Community Guidelines
15+
16+
If you are confused β€” **that’s normal**. Ask questions.
17+
18+
---
19+
20+
## 🧭 Ways to Contribute
21+
22+
You can contribute in many ways:
23+
24+
### πŸ“ Documentation
25+
- Fix typos or grammar
26+
- Improve clarity
27+
- Add missing sections
28+
- Write guides or tutorials
29+
30+
### πŸ’» Code
31+
- Bug fixes
32+
- Feature improvements
33+
- UI/UX enhancements
34+
- Performance optimizations
35+
36+
### 🐞 Issues
37+
- Report bugs
38+
- Suggest improvements
39+
- Discuss ideas
40+
41+
### 🎨 Design & UX
42+
- Icons
43+
- Layout suggestions
44+
- Accessibility improvements
45+
46+
---
47+
48+
49+
---
50+
51+
## πŸ” Contribution Workflow (Step by Step)
52+
53+
### 1️⃣ Fork the Repository
54+
Click the **Fork** button on GitHub.
55+
56+
---
57+
58+
### 2️⃣ Clone Your Fork
59+
```bash
60+
git clone https://github.com/<your-username>/<repo-name>.git
61+
cd <repo-name>
62+
````
63+
64+
---
65+
66+
### 3️⃣ Create a New Branch
67+
68+
Never work directly on `main`.
69+
70+
```bash
71+
git checkout -b feature/short-description
72+
```
73+
74+
Examples:
75+
76+
* `fix/navbar-bug`
77+
* `docs/add-install-guide`
78+
* `feature/project-search`
79+
80+
---
81+
82+
### 4️⃣ Make Your Changes
83+
84+
* Keep changes focused
85+
* Follow existing code style
86+
* Add comments if needed
87+
88+
---
89+
90+
### 5️⃣ Commit Like a Pro
91+
92+
Use **clear and meaningful commit messages**:
93+
94+
```bash
95+
git commit -m "docs: improve contribution guide clarity"
96+
```
97+
98+
Format:
99+
100+
```
101+
type: short description
102+
```
103+
104+
Examples:
105+
106+
* `fix: resolve crash on login`
107+
* `feat: add project collaboration page`
108+
* `docs: update README`
109+
110+
---
111+
112+
### 6️⃣ Push Your Branch
113+
114+
```bash
115+
git push origin feature/short-description
116+
```
117+
118+
---
119+
120+
### 7️⃣ Open a Pull Request (PR)
121+
122+
When opening a PR:
123+
124+
* Clearly explain **what** you changed
125+
* Explain **why** you changed it
126+
* Reference related issues if any
127+
128+
Good PR description:
129+
130+
> This PR improves documentation clarity for new contributors by adding examples and fixing grammar.
131+
132+
---
133+
134+
## βœ… Pull Request Rules
135+
136+
Your PR should:
137+
138+
* Be focused (one feature/fix per PR)
139+
* Not break existing functionality
140+
* Follow project structure
141+
* Pass any required checks
142+
143+
Maintainers may:
144+
145+
* Request changes
146+
* Suggest improvements
147+
* Ask questions
148+
149+
This is normal β€” don’t take it personally.
150+
151+
---
152+
153+
## πŸ§ͺ Testing (If Applicable)
154+
155+
Before submitting:
156+
157+
* Test your changes locally
158+
* Ensure the app builds/runs
159+
* Check docs formatting
160+
161+
---
162+
163+
## πŸ“Œ Issue Guidelines
164+
165+
When creating an issue:
166+
167+
* Use a clear title
168+
* Describe the problem clearly
169+
* Add screenshots if possible
170+
* Mention steps to reproduce (for bugs)
171+
172+
Avoid vague issues like:
173+
174+
> β€œApp not working”
175+
176+
---
177+
178+
## πŸ™‹ Need Help?
179+
180+
If you’re stuck:
181+
182+
* Comment on the issue
183+
* Ask in discussions
184+
* Reach out to maintainers
185+
186+
**Asking questions is encouraged.**
187+
188+
---
189+
190+
## 🏁 Final Words
191+
192+
You don’t need to be perfect to contribute.
193+
You just need to be honest, respectful, and willing to learn.
194+
195+
Every contribution β€” big or small β€” matters.
196+
197+
Welcome to Gecian Hub πŸ’™
198+
199+
```
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
2+
3+
# πŸ“œ COMMUNITY GUIDELINES
4+
5+
πŸ‘‰ `COMMUNITY_GUIDELINES.md` or `docs/community/community-guidelines.md`
6+
7+
```md
8+
# Community Guidelines – Gecian Hub
9+
10+
Welcome to the **Gecian Hub community** πŸ‘‹
11+
This document outlines how we work together and what we expect from everyone participating in our GitHub organization.
12+
13+
Gecian Hub exists to help students learn, collaborate, and grow through open source.
14+
To make that possible, we value **respect, learning, and transparency** over perfection.
15+
16+
---
17+
18+
## 🌱 Our Core Values
19+
20+
### 1. Learning Over Ego
21+
No one here is expected to know everything.
22+
- Beginners are welcome
23+
- Questions are encouraged
24+
- Mistakes are part of learning
25+
26+
There is no place for superiority or gatekeeping.
27+
28+
---
29+
30+
### 2. Respect for Everyone
31+
We respect all contributors regardless of:
32+
- Branch or department
33+
- Experience level
34+
- Background or opinions
35+
36+
Harassment, discrimination, or personal attacks will **not** be tolerated.
37+
38+
---
39+
40+
### 3. Transparency & Honesty
41+
- Decisions should be explained clearly
42+
- Credits should be given fairly
43+
- If something doesn’t work, we talk about it openly
44+
45+
---
46+
47+
### 4. Community Before Code
48+
Code matters β€” but people matter more.
49+
50+
We prioritize:
51+
- Healthy collaboration
52+
- Constructive feedback
53+
- Long-term sustainability
54+
55+
---
56+
57+
## 🀝 Expected Behavior
58+
59+
We expect all community members to:
60+
61+
- Be polite and respectful in discussions
62+
- Give constructive and kind feedback
63+
- Accept feedback without hostility
64+
- Help others when possible
65+
- Follow repository rules and documentation
66+
67+
---
68+
69+
## 🚫 Unacceptable Behavior
70+
71+
The following will **not** be accepted:
72+
73+
- Harassment or hate speech
74+
- Personal attacks or insults
75+
- Spamming issues or pull requests
76+
- Stealing credit for others’ work
77+
- Forcing changes without discussion
78+
79+
Repeated violations may result in removal from the organization.
80+
81+
---
82+
83+
## πŸ›  Maintainers & Decision Making
84+
85+
Maintainers are responsible for:
86+
- Reviewing pull requests
87+
- Managing issues
88+
- Guiding contributors
89+
90+
Final decisions rest with maintainers, but:
91+
- Feedback is always welcome
92+
- Discussions are encouraged
93+
- Decisions should be explained
94+
95+
---
96+
97+
## πŸ†˜ Reporting Issues
98+
99+
If you experience or witness unacceptable behavior:
100+
- Reach out to a maintainer privately
101+
- Or open a confidential issue if applicable
102+
103+
Your concerns will be taken seriously.
104+
105+
---
106+
107+
## ❀️ Final Note
108+
109+
Gecian Hub is built **by students, for students**.
110+
Be kind, be patient, and help make this a safe place to learn.
111+
112+
Thank you for being part of the community.
113+
```
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
Β (0)