Skip to content

Commit

Permalink
update the text on contributerguide.html
Browse files Browse the repository at this point in the history
  • Loading branch information
@hizclick
hizclick committed Feb 12, 2025
1 parent 16ac329 commit f95c187
Showing 1 changed file with 30 additions and 126 deletions.
156 changes: 30 additions & 126 deletions contributerguide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,129 +5,33 @@


<div class="row">
<div class="col">
<h1>Contributor's Guide: Writing a Good Proposal</h1>

<h2>1. Understand the Project and Organization</h2>
<p>Before you start writing your proposal:</p>
<ul>
<li>Carefully read the project ideas listed by the organization.</li>
<li>Research past projects and contributions to understand what has been done.</li>
<li>Join Vife's Matrix GSOC channel.</li>
<li>Engage with the community and introduce yourself.</li>
<li>Reach out to mentors and admins for guidance.</li>
<li>Complete any warm-up tasks suggested by the organization.</li>
</ul>

<h2>2. Structure of a Strong Proposal</h2>
<p>A well-structured proposal is key to acceptance. Below is a recommended outline:</p>

<h3>Title and Personal Details</h3>
<ul>
<li>Project title</li>
<li>Your full name, email, GitHub or other relevant profiles</li>
<li>Organization and project name</li>
</ul>

<h3>Synopsis</h3>
<ul>
<li>A short summary of the project and your planned contributions.</li>
<li>Clearly define the problem and its significance.</li>
</ul>

<h3>Benefits to the Community</h3>
<ul>
<li>Explain how your project benefits the open-source community and the organization.</li>
<li>Mention how it aligns with the organization's goals.</li>
</ul>

<h3>Deliverables</h3>
<ul>
<li>List expected deliverables with clear objectives.</li>
<li>Define project milestones with estimated completion dates.</li>
<li>Specify key technical and implementation details.</li>
</ul>

<h3>Technical Details</h3>
<ul>
<li>Provide a high-level overview of how you plan to implement the project.</li>
<li>List the technologies, frameworks, and tools you will use.</li>
<li>Reference existing repositories, APIs, or dependencies.</li>
</ul>

<h3>Timeline</h3>
<ul>
<li>Create a detailed week-by-week or phase-wise breakdown of your work.</li>
<li>Include buffer time for potential delays.</li>
</ul>

<h3>Expected Outcomes</h3>
<ul>
<li>Describe the final expected results, including potential extensions.</li>
<li>Discuss how the project can be maintained beyond the program period.</li>
</ul>

<h3>Resources & Dependencies</h3>
<ul>
<li>List any resources (software, datasets, APIs) needed for the project.</li>
<li>Mention possible blockers and how you plan to overcome them.</li>
</ul>

<h3>Personal Background</h3>
<ul>
<li>Summarize your education, work, and open-source experience.</li>
<li>Highlight relevant projects or contributions.</li>
<li>Link your portfolio, GitHub, blog, or any relevant work.</li>
</ul>

<h3>Community Engagement</h3>
<ul>
<li>Describe how you plan to communicate progress (weekly reports, blog posts, etc.).</li>
<li>Mention how you will seek feedback and collaborate with the community.</li>
</ul>

<h3>Why You?</h3>
<ul>
<li>Explain why you are the best candidate for the project.</li>
<li>Highlight unique skills and experiences that make you a good fit.</li>
</ul>

<h2>3. Best Practices for Writing a Winning Proposal</h2>
<ul>
<li><strong>Be clear and concise:</strong> Avoid vague descriptions; be specific about deliverables and timelines.</li>
<li><strong>Show feasibility:</strong> Ensure your proposal is realistic and can be completed within the timeframe.</li>
<li><strong>Engage with the community:</strong> Active participation can strengthen your proposal.</li>
<li><strong>Get feedback:</strong> Share your draft with mentors and peers for review.</li>
<li><strong>Follow the organization’s guidelines:</strong> Each organization may have specific requirements—adhere to them strictly.</li>
<li><strong>Proofread:</strong> A well-written, error-free proposal creates a great impression.</li>
</ul>

<h2>4. Contacting Mentors and Admins</h2>
<ul>
<li>Reach out via the Matrix channel.</li>
<li>Ask questions and clarify doubts about the project.</li>
<li>Request feedback on your ideas before finalizing the proposal.</li>
</ul>

<h2>5. Preparing with Warm-Up Tasks</h2>
<ul>
<li>Warm-up tasks help demonstrate your commitment and technical abilities.</li>
<li>Share your solutions and discuss them with mentors for feedback.</li>
</ul>

<h2>Final Submission Tips</h2>
<ul>
<li>Start drafting early and iterate based on feedback.</li>
<li>Double-check the submission deadline and format requirements.</li>
<li>Submit before the deadline to avoid last-minute issues.</li>
</ul>

<h2>Additional Resources</h2>
<ul>
<li><a href="https://developers.google.com/open-source/gsoc/help/contributor-guidance">Google GSoC Contributor Guidance</a></li>
<li><a href="https://google.github.io/gsocguides/student/writing-a-proposal">Google GSoC Proposal Writing Guide</a></li>
</ul>

<p><strong>GOOD LUCK!</strong></p>
</div>
</div>
<div class="col">
<h2>Contributor's Guide: Writing a Proposal</h2>
<h3>Understand the Organization</h3>
<p>
Virtual Research Network Edirom (ViFE) is an association of current and former employees of the Detmold/Paderborn Department of Musicology who are involved in various projects dealing with the application of digital methods in musicology. The common goal is to promote digital work in the field of musicological research, in particular digital text and music editions. ViFE organizes the annual Edirom Summer School.

The network is named after the DFG project for the development of tools for digital forms of scholarly-critical music editions (2006-2012), which became known as “Edirom” and formed the starting point for a series of other digital projects.

The focus of the network's national and international work is on the conception of digital editions and their forms of publication, the application and further development of relevant standards (TEI, MEI) and tools, questions of data modelling and project organization, the promotion of communication between digitally working projects and institutions and the transfer of relevant knowledge and skills. The network partners are working together to develop skills in these areas in order to be available as contacts for the new digital community.
</p>
<h3>Understand the Project ideas</h3>
<p>Before you start writing your proposal:</p>
<ul>
<li>Carefully read the project <a href="https://edirom.de/gsoc.html"> ideas. </a></li>
<li>Join Vife’s Matrix GSOC public <a href="https://matrix.to/#/#gsoc-public:edirom.de"> channel. </a></li>
<li>Engage with the community and introduce yourself.</li>
<li>Reach out to mentors and admins for guidance.</li>
<li>Complete the warm-up tasks mentioned in each <a href="https://edirom.de/gsoc.html"> ideas. </a></li>
<li>Make yourslf familiar with <a href="https://github.com/Edirom/Edirom-Online"> Edirom </a> code base.</li>
</ul>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://developers.google.com/open-source/gsoc/help/contributor-guidance">Google GSoC Contributor Guidance</a></li>
<li><a href="https://google.github.io/gsocguides/student/writing-a-proposal">Google GSoC Proposal Writing Guide</a></li>
</ul>

<p><strong>GOOD LUCK!</strong></p>
</div>
</div>

0 comments on commit f95c187

Please sign in to comment.