Project Proposal Template¶
GSoC 2024 will not have Mathesar
Mathesar will not be participating in Google Summer of Code (GSoC) 2024 due to lack of maintainer capacity. We hope to resume participation in 2025.
This guide was for GSoC 2023.
This is the proposal template for applications to any mentorship programs that we participate in. Proposals that do not follow this template will not be considered for GSoC.
We recommend creating a Google Doc that follows this structure and sharing it with the mentors. Please make sure that all mentors have commenting permissions.
Information
The template starts below this box. Instructions for each section are provided in infoboxes like this one.
Project Title¶
Synopsis¶
In your own words, provide a one paragraph synopsis of the project and outcomes you are proposing in this section.
Implementation¶
Describe how your solution will be implemented in Mathesar. Provide as many technical details as possible with references to how your solution will fit into the current code, APIs, and UI.
API spec¶
If your project involves APIs, please propose an API spec here. API specs should include URLs and exanple JSON requests and responses.
UX design¶
If your project involves UI changes, describe the UI changes that will be needed. Be specific about which screens need to change. Also include wireframes / mockups.
Architectural / UX problems¶
Describe the architectural and/or UX problems in this project and explain how you plan to solve them.
External Dependencies¶
If your solution involves adding external libraries to use, provide details about your choices and the reasons behind those choices.
Research & References¶
Include any research you’ve done or references that you’ve found related to your solution here.
Timeline & Deliverables¶
Include a timeline of the deliverables you aim to accomplish each week. Add one row per 1-2 weeks. We use this section to determine whether you can plan your project out properly, so please choose your deliverables well.
Deliverables should be measurable and as specific as possible.
- “Complete API for cancelling orders” is a good deliverable. It’s easy to tell whether it’s been completed.
- “Work on APIs” is a bad deliverable. It’s not measurable.
The GSoC timeline should be helpful in determining dates.
Timeline of deliverables | Timeframe | Deliverable | |-|-| | Community Bonding period | Plan for getting up to speed | | Week 1: Dates go here | Deliverable details go here | | … | … |
Questionnaire¶
Information
Please answer the following questions.
- Why are you interested in working on Mathesar?
- Why are you interested in working on this project idea?
- What about your skills and experience makes you well-suited to take on this project?
- Do you have any other commitments during the program period? Provide dates, such as holidays, when you will not be available.
- If your native language is not English, are you comfortable working closely with a mentor in English?
- Have you worked on a project remotely and/or with people in other timezones before? If you have, please provide details.
- Are you interested in contributing to Mathesar after the program is complete?
General Information¶
This section provides general information about you.
Use the sub-sections provided below. You may add more if needed, but do not remove any sections.
About Me¶
Please provide a short bio.
Contact Information¶
Please provide the following information.
- Full name
- Email address
- Matrix username
- GitHub username
- Personal website (if you have one)
- Phone number
- Emergency contact information
Education¶
If you went to university, please provide:
- Institute
- Degree
- Major
- Graduation year
- Courses taken
Skills¶
List your skills below in the format provided. Skills can be technical (programming languages, frameworks, tools, version control systems, etc.) or non-technical (writing, research, etc.). Prioritize skills that are relevant to the project you’re applying for.
Feel free to add as many rows as you need.
| Skill name | Proficiency (1-5) | Where you’ve used this skill |
|---|---|---|
| Example skill | 5 | As part of college coursework |
Experience¶
List your previous experience that’s relevant to this project. This can be previous work or internship experiences, side projects, or open source contributions.
Feel free to add as many rows as you need.
| Brief description | Relevant links | Additional notes |
|---|---|---|
| Example #1 - PR merged to open source project X | Link to PR | - |
| Example #2 - Side project | Link to project repo and website | Worked on this project for X time period |
Contributions to Mathesar¶
Please list your contributions to Mathesar here – one line per issue/pull request you’ve worked on. You should have at least one of these.
Feel free to add as many rows as you need.
| Issue title | Links to issue and/or PR | Additional notes |
|---|---|---|
| Solved issue #23: “Example issue name” | Link to issue, Link to PR | - |