Difference between revisions of "GSoC Student Guidelines"

From Audacity Wiki
Jump to: navigation, search
(Updates.)
(Trimmed down for 2021.)
Line 5: Line 5:
 
* We expect you to join the [http://lists.sourceforge.net/lists/listinfo/audacity-devel audacity-devel mailing list]. Most discussion of your projects should be on this list, but you can continue to use our [mailto:[email protected] summerofcode email address] to contact mentors and admins directly.  
 
* We expect you to join the [http://lists.sourceforge.net/lists/listinfo/audacity-devel audacity-devel mailing list]. Most discussion of your projects should be on this list, but you can continue to use our [mailto:[email protected] summerofcode email address] to contact mentors and admins directly.  
  
* An email forward is setup for GSoC students at [mailto:[email protected] [email protected]].
+
* An email forward is setup for GSoC students at [mailto:[email protected] [email protected]].  All Audacity GSoC mentors and admins receive this.
  
 
* When we need to contact you directly, we will use the gmail or googlemail address you gave us, so check those regularly.  
 
* When we need to contact you directly, we will use the gmail or googlemail address you gave us, so check those regularly.  
  
* Different mentors in Audacity may have different views on the same issues - it's part of the nature of open source. [[User:Vaughan|Vaughan]] is our GSoC Admin and has overall responsibility and authority for our GSoC involvement, so makes the "final decisions". This helps keep things moving, so we make decisions now rather than taking too long to reach an "optimum decision". We hope this works as well for you as it does for us.
+
* If you have quick easy questions during your GSoC work, use the [https://t.me/joinchat/IDBelUutbHgYBHes telegram address].  Thornier questions by email.  
  
* We encourage students to start a User: page on this Wiki (that is, "please introduce yourself"). Students must start a progress page for their project and call it as per the title on the GSoC Projects page. See the [[GSoC 2008 Projects|GSoC 2008 Projects page]] to get the idea. Also see our [[GSoC News and Tips#Wiki Editing|Wiki editing tips]] on [[GSoC News and Tips]].
+
* Different mentors in Audacity may have different views on the same issues - it's part of the nature of open source. Buanzo is our GSoC Admin and has overall responsibility and authority for our GSoC involvement, so makes the "final decisions". This helps keep things moving, so we make decisions now rather than taking too long to reach an  "optimum decision". We hope this works as well for you as it does for us.
  
 
* Please read the [[Developer_Guide | Developer Guide]], especially [[Developer_Guide#Tips_for_New_Developers | Tips for New Developers]].
 
* Please read the [[Developer_Guide | Developer Guide]], especially [[Developer_Guide#Tips_for_New_Developers | Tips for New Developers]].
Line 19: Line 19:
  
 
* Weekly status reports of the "this is going well...  and this isn't...." kind to be sent to [mailto:[email protected] [email protected]] (so this will include your mentor). These should be brief and focused.
 
* Weekly status reports of the "this is going well...  and this isn't...." kind to be sent to [mailto:[email protected] [email protected]] (so this will include your mentor). These should be brief and focused.
** We are considering requiring weekly updates on a wiki page from both students and mentors, staggered though the week (say Saturday for one and Wednesday for the other) with corresponding posts on audacity-devel, enabling tighter monitoring.
+
** Share a Google doc with us for progress.
** We are also considering having a collaborative calendar for all students and mentors to register milestones, planned absences and so on.
+
** Notify us of calendar/time issues well in advance.  If you know you will have exams during GSoC, tell us the dates when you apply.
  
* Keep a record of code you write so that you are ready to upload it to Google at the end of project. We'll ask for tarballs of your code at the mid-term as a practice run.
+
* Start an account on GitHub before you apply.
 
+
* We expect documentation of your contributions at both mid-term and final stages, both from an 'end user' perspective and from a 'developer' perspective.  Again write it in a Google doc and share that with your mentor.
* We'll freeze "kick-the-tires" alphas semi-monthly, on the 1st and 15th, for all three platforms, to test the code. This means that on the designated dates, your latest code that's at least partially working should build without breaking anything.
 
 
 
* We expect documentation of your contributions at both mid-term and final stages, both from an 'end user' perspective and from a 'developer' perspective.
 
  
 
[[Category:GSoC]]
 
[[Category:GSoC]]

Revision as of 18:49, 19 February 2021

Google Summer of Code (GSoC) is Google's program for promoting Open Source Software development. Audacity was a mentoring organization for five students for Google Summer of Code 2008, and mentored two students in 2009. This page contains our Policy Guidelines and Requirements for Audacity Student Participants in Google Summer of Code.
For information about our future plans and about Audacity software development, please join our developers mailing list
 
Related article(s):


  • An email forward is setup for GSoC students at [email protected]. All Audacity GSoC mentors and admins receive this.
  • When we need to contact you directly, we will use the gmail or googlemail address you gave us, so check those regularly.
  • If you have quick easy questions during your GSoC work, use the telegram address. Thornier questions by email.
  • Different mentors in Audacity may have different views on the same issues - it's part of the nature of open source. Buanzo is our GSoC Admin and has overall responsibility and authority for our GSoC involvement, so makes the "final decisions". This helps keep things moving, so we make decisions now rather than taking too long to reach an "optimum decision". We hope this works as well for you as it does for us.


Requirements

  • Weekly status reports of the "this is going well... and this isn't...." kind to be sent to [email protected] (so this will include your mentor). These should be brief and focused.
    • Share a Google doc with us for progress.
    • Notify us of calendar/time issues well in advance. If you know you will have exams during GSoC, tell us the dates when you apply.
  • Start an account on GitHub before you apply.
  • We expect documentation of your contributions at both mid-term and final stages, both from an 'end user' perspective and from a 'developer' perspective. Again write it in a Google doc and share that with your mentor.