Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Google Summer of Code Contributor Guide #485

Merged
merged 1 commit into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions GSOC/Contributor Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Chimoney Contributor Guide

Welcome to Chimoney's Google Summer of Code (GSoC) contributor guide! We are excited to mentor and collaborate with open-source contributors who are passionate about fintech, APIs, and developer experience. This guide will help you write a strong proposal for your GSoC project with Chimoney.

## What We Look for in a Proposal

A strong GSoC proposal should demonstrate:

- **Understanding of the Project** – Clearly explain what the project is about and why it is important.

- **Clarity & Structure** – A well-organized proposal with clear goals, milestones, and deliverables.

- **Feasibility** – A realistic timeline with achievable milestones.

- **Technical Approach** – A well-thought-out plan for implementation, including relevant tools and technologies.

- **Engagement & Communication** – Show how you plan to communicate progress and seek feedback.

- **Passion & Initiative** – Demonstrate your motivation and why you’re a great fit for the project.

## Proposal Template

#### Personal Information

- Full Name:

- GitHub Profile Link:

- Email Address:

- Time Zone & Availability:

- Programming Experience: (Languages, frameworks, tools, relevant experience)

#### Project Title

A clear and concise title that reflects the project idea.

#### Synopsis

A short summary (2-3 sentences) describing the project and its goals.

#### Benefits to the Community

Explain how your project will benefit Chimoney’s open-source ecosystem and fintech users.

#### Deliverables

A list of what you plan to achieve during the program. Be specific!

#### Technical Details & Approach

- Mention any programming languages, frameworks, or databases you plan to use.

- Outline how you plan to build the project step by step.

- Identify any risks and how you plan to mitigate them.

#### Timeline & Milestones

Break down your project into weekly milestones, keeping in mind the official GSoC timeline.
| Week | Milestone |
| --------| ------- |
| Community Bonding | Understanding the codebase, engaging with mentors |
| Week 1-2| Initial setup, research, and design |
| Week 3-6 | Core development phase |
| Week 7-9 | Testing and improvements |
| Week 10-12 | Final touches, documentation, and submission |







#### Communication Plan

How do you plan to keep your mentors and the Chimoney community updated on your progress? Examples:

- Weekly progress reports on GitHub Issues/Discussions

- Regular check-ins with mentors on Slack or Discord

- Public blog updates

#### Why Me?

Tell us why you are the best candidate for this project! Highlight your:

- Relevant experience

- Passion for fintech/open source

- Previous contributions to Chimoney or similar projects

## How to Reach Us

For any questions, guidance, or feedback, you can reach out to us via:


- [Discord Community](https://discord.gg/99CF9k3R)

- Email: community@chimoney.io

30 changes: 15 additions & 15 deletions gsoc-ideas.md → GSOC/Project Ideas.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Google Summer of Code (GSoC) 2025 - Chimoney Open Source Projects
# Google Summer of Code 2025 - Chimoney Open Source Projects

Welcome to Chimoney's **Google Summer of Code (GSoC) 2025** Ideas List! 🚀
Welcome to Chimoney's **Google Summer of Code (GSoC) 2025** Ideas List!

Chimoney is committed to enabling seamless global payments through open-source technologies. Below are project ideas for potential GSoC contributors to work on.
If you're interested, be sure to check out the requirements and get in touch!

---

## 🌟 How to Participate
## How to Participate

1. **Explore the Project Ideas** below and find one that excites you.
1. **Explore the project Ideas** below and find one that excites you.
2. **Check the required skills** and resources to see if it's a good fit.
3. **Join our Community** [Discord](https://discord.gg/TsyKnzT4qV) to discuss ideas and ask questions.
4. **Submit a Proposal** following the GSoC guidelines.
3. **Join our community** on [discord](https://discord.gg/TsyKnzT4qV) to discuss ideas and ask questions.
4. **Submit a proposal** following the GSoC guidelines.

---

## 📌 Project Ideas

### 1️⃣ ** **
### ** **
**Description:** [ ]
- **Expected Outcome:** [ ]
- **Skills Required:** [ ]
Expand All @@ -27,7 +27,7 @@ If you're interested, be sure to check out the requirements and get in touch!

---

### 2️⃣ ** **
### ** **
**Description:** [ ]
- **Expected Outcome:** [ ]
- **Skills Required:** [ ]
Expand All @@ -36,17 +36,17 @@ If you're interested, be sure to check out the requirements and get in touch!

---

## 🔗 Resources
- [Chimoney API Documentation](https://chimoney.readme.io/reference/getting-started-with-your-api)
## Resources
- [Chimoney GitHub Repos](https://github.com/Chimoney)

- [Chimoney API Documentation](https://chimoney.readme.io/reference/getting-started-with-your-api)
- [Google Summer of Code Guidelines](https://summerofcode.withgoogle.com/)

## 💬 Contact Us
## Contact Us
Have questions? Join our **Discord Community** or create an issue in the **GitHub Repository** to start a discussion.

📩 **Email:** community@chimoney.io
🌍 **Website:** [chimoney.io](https://chimoney.io)
**Email:** community@chimoney.io

---
**Website:** [chimoney.io](https://chimoney.io)

🎉 We look forward to seeing your contributions!
---