Skip to content

Commit a9f40c7

Browse files
committed
added more file to teh docs
1 parent 51320ac commit a9f40c7

File tree

12 files changed

+1005
-5
lines changed

12 files changed

+1005
-5
lines changed

docs/faq/contributors.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
2+
3+
# ❓ Contributor FAQ — Gecian Hub
4+
5+
## 1. Who can contribute to Gecian Hub?
6+
7+
In general, **any student interested in learning and contributing is welcome**.
8+
9+
However, some contributions—especially those related to **college-specific data, workflows, or internal coordination**—may be limited to **students of the host college** (e.g., GEC SKP) to ensure accuracy, safety, and accountability.
10+
11+
This distinction will always be **clearly mentioned in the issue description**.
12+
13+
---
14+
15+
## 2. Is Gecian Hub restricted only to students of the host college?
16+
17+
No.
18+
Gecian Hub follows an **open and learning-friendly approach**.
19+
20+
* **Open issues** → Anyone can contribute
21+
* **College-specific issues** → Restricted to host college students
22+
23+
This model ensures both **openness** and **responsible development**.
24+
25+
---
26+
27+
## 3. Do I need prior experience to contribute?
28+
29+
No prior experience is required.
30+
31+
Gecian Hub is designed as a **beginner-friendly project**, making it an excellent starting point for:
32+
33+
* First-time contributors
34+
* Students new to GitHub
35+
* Those learning open-source workflows
36+
37+
Guidance and reviews are provided where possible.
38+
39+
---
40+
41+
## 4. How difficult are the tasks compared to large open-source projects?
42+
43+
Most tasks in Gecian Hub are **significantly simpler** than those in large or well-established open-source organizations.
44+
45+
The project is intentionally structured to:
46+
47+
* Reduce complexity
48+
* Encourage learning
49+
* Provide confidence through small wins
50+
51+
It serves as a **stepping stone** before contributing to larger open-source projects.
52+
53+
---
54+
55+
## 5. Are there advanced or restricted issues?
56+
57+
Yes. Some issues may:
58+
59+
* Require access to internal systems
60+
* Involve real student data
61+
* Affect live deployments
62+
* Need on-campus coordination
63+
64+
Such issues are usually:
65+
66+
* Marked clearly
67+
* Assigned to **core team members or host college students**
68+
* Not suitable for first-time contributors
69+
70+
---
71+
72+
## 6. How will I know which issues I can work on?
73+
74+
Each issue will clearly mention:
75+
76+
* Skill level (beginner / intermediate)
77+
* Whether it is **open to all contributors**
78+
* Whether it is **restricted to host college students**
79+
80+
If unsure, always **comment on the issue and ask** before starting work.
81+
82+
---
83+
84+
## 7. Can contributors from other colleges join the core team?
85+
86+
Core team membership generally prioritizes:
87+
88+
* Availability
89+
* Long-term commitment
90+
* Understanding of the host college environment
91+
92+
Students from other colleges may contribute regularly, but **core leadership roles are usually reserved for host college students** to ensure continuity and accountability.
93+
94+
---
95+
96+
## 8. Will contributors receive mentorship or guidance?
97+
98+
Yes, where possible.
99+
100+
* Maintainers review Pull Requests
101+
* Feedback is provided constructively
102+
* Learning is encouraged over perfection
103+
104+
However, contributors are expected to:
105+
106+
* Read documentation
107+
* Follow contribution guidelines
108+
* Respect maintainers’ time
109+
110+
---
111+
112+
## 9. What is expected from contributors?
113+
114+
Contributors should:
115+
116+
* Follow GitHub best practices
117+
* Communicate respectfully
118+
* Complete tasks they take responsibility for
119+
* Avoid submitting incomplete or rushed PRs
120+
121+
Quality matters more than quantity.
122+
123+
---
124+
125+
## 10. Can I use my contributions for learning or resumes?
126+
127+
Yes.
128+
Contributions to Gecian Hub are:
129+
130+
* Public
131+
* Open-source
132+
* Valid learning experience
133+
134+
You are encouraged to showcase your work responsibly.
135+
136+
---

docs/faq/general.md

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
2+
# ❓ General FAQ — Gecian Hub
3+
4+
## 1. What is Gecian Hub?
5+
6+
Gecian Hub is a student-first platform built to solve real problems faced in daily college life.
7+
It focuses on accessibility, simplicity, collaboration, and ethical use of technology to support students across departments and years.
8+
9+
---
10+
11+
## 2. Who runs Gecian Hub?
12+
13+
Gecian Hub is run by a **student core team** under a designated **Project Lead (Head)**.
14+
Leadership may change over time through a documented succession process to ensure continuity.
15+
16+
---
17+
18+
## 3. Is Gecian Hub an official college project?
19+
20+
Gecian Hub is a **student-led initiative**.
21+
While it may collaborate with departments or faculty when required, it operates independently unless explicitly stated otherwise.
22+
23+
---
24+
25+
## 4. Who can use Gecian Hub?
26+
27+
All students are welcome to use Gecian Hub, regardless of:
28+
29+
* Department
30+
* Year of study
31+
* Technical background
32+
33+
Some features may be limited to verified students to ensure safety and trust.
34+
35+
---
36+
37+
## 5. Is Gecian Hub free to use?
38+
39+
Yes.
40+
Gecian Hub is **free for students** and is not built for profit.
41+
42+
---
43+
44+
## 6. Who can contribute to the project?
45+
46+
Anyone interested in contributing can do so, including:
47+
48+
* Developers
49+
* Designers
50+
* Writers
51+
* Testers
52+
* Documentation contributors
53+
54+
Technical knowledge is helpful but **not mandatory** for all contributions.
55+
56+
---
57+
58+
## 7. How do I start contributing?
59+
60+
Start by:
61+
62+
1. Reading the **Contribution Guidelines**
63+
2. Checking open GitHub issues
64+
3. Commenting on an issue before starting work
65+
4. Submitting a Pull Request (PR)
66+
67+
All contributions follow open-source best practices.
68+
69+
---
70+
71+
## 8. Do I need to be an expert in Git or programming?
72+
73+
No.
74+
However, **core team members and leads** are expected to understand:
75+
76+
* Creating GitHub issues
77+
* Working with branches
78+
* Submitting and reviewing PRs
79+
* Basic open-source workflows
80+
81+
Beginners are encouraged to learn and grow.
82+
83+
---
84+
85+
## 9. How are decisions made?
86+
87+
Decisions are made through:
88+
89+
* Discussion within the core team
90+
* Technical review when required
91+
* Final responsibility resting with the Project Lead
92+
93+
All decisions should prioritize the project’s long-term health and student benefit.
94+
95+
---
96+
97+
## 10. Is the platform politically or ideologically affiliated?
98+
99+
No.
100+
Gecian Hub maintains a **politically neutral stance** and avoids promoting ideological, religious, or controversial agendas.
101+
102+
---
103+
104+
## 11. What kind of content is not allowed?
105+
106+
Content that is:
107+
108+
* Harmful, offensive, or discriminatory
109+
* Politically provocative
110+
* Culturally insensitive or indecent
111+
* Violates privacy or ethical standards
112+
113+
The platform aims to maintain a **safe and respectful environment**.
114+
115+
---
116+
117+
## 12. How is user data handled?
118+
119+
User data is handled responsibly and minimally.
120+
We do not misuse personal data, and access is restricted to authorized maintainers only.
121+
122+
Refer to the **Privacy Policy** for details.
123+
124+
---
125+
126+
## 13. What happens if something breaks or the site goes down?
127+
128+
The project follows a documented **Incident Response & Recovery process** to:
129+
130+
* Identify the issue
131+
* Minimize impact
132+
* Restore services safely
133+
134+
Lessons learned are documented to prevent repetition.
135+
136+
---
137+
138+
## 14. What happens if leadership becomes inactive?
139+
140+
If leadership succession fails, the project may be responsibly restarted following the **Succession Failure & Project Continuity Protocol**, ensuring the original mission continues.
141+
142+
---
143+
144+
## 15. How can I contact the team?
145+
146+
* Official communication channels (email, forms, or GitHub)
147+
* For succession or continuity matters, previous leads may be contacted if necessary
148+
149+
Avoid direct personal messages unless requested.
150+
151+
---
152+
153+
## 16. Where can I report issues or suggest features?
154+
155+
* GitHub Issues (preferred)
156+
* Official feedback forms if available
157+
158+
Clear, constructive reports help the project improve faster.
159+
160+
---
161+
162+
## 17. Can this project be forked or reused?
163+
164+
Yes, under the project’s open-source license.
165+
However, forks should respect:
166+
167+
* Ethical guidelines
168+
* Attribution requirements
169+
* Community responsibility
170+
171+
---
172+

0 commit comments

Comments
 (0)