Difference between revisions of "GSoC Student Guidelines"

From Audacity Wiki
Jump to: navigation, search
(Discord update)
 
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Intro|Guidelines for Student Participants for Audacity in [[GSoC Ideas|Google Summer of Code]]|}}
+
{{GSoC_Header|This page contains our Policy Guidelines and Requirements for Audacity Student Participants in Google Summer of Code}}  
  
  
See [[GSoC_News_and_Tips GSoC News and Tips]] for handy hints. This page is primarily about policy.
 
  
Most discussion of your projects should be on the audacity-devel mailing list, but you can continue to use {{external|[mailto:summerofcode@audacityteam.org summerofcode@audacityteam.org]}} to contact all the 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:gsoc@audacityteam.org summerofcode email address] to contact mentors and admins directly.  
  
When we need to contact you directly, we will use the gmail/googlemail address you gave us, so check those regularly.  
+
* An email forward is setup for GSoC students at [mailto:[email protected] [email protected]].  All Audacity GSoC mentors and admins receive this.
  
Different mentors in Audacity will have different views on the exact same issues - it's part of the nature of open source. We have Vaughan as our Admin for GSoC 2008 and we have given him responsibilities and authority for the GSoC time. Partly this is because for some decisions it's more important to make a decision now than to reach the 'optimum decision' but take too long about it. We hope this works as well for you as it does for us.
+
* When we need to contact you directly, we will use the gmail or googlemail address you gave us, so check those regularly.  
  
We encourage students to start a User: and a project page on the wikiI.e. "please introduce yourself". Hints for editing the Wiki are at [[GSoC_News_and_Tips GSoC News and Tips]].
+
* If you have quick easy questions during your GSoC work, use the [https://discord.gg/QtkZDUEphQ discord 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 ==
+
* Please read the [[Developer_Guide | Developer Guide]], especially [[Developer_Guide#Tips_for_New_Developers | Tips for New Developers]].
  
* 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.
 
  
* 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.
+
== Requirements ==
  
* We'll build kick-the-tires betas every two weeks, for all three platforms. This means that on the designated bi-weekly dates, your latest code that's at least partially working, should build without breaking anything.
+
* 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.
 +
** 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 and clone Audacity before you apply.
 +
** During the GSoC project we expect fairly regular check ins of work in progress into your fork of Audacity.  If you are accepted, start working but then miss a weekly status report, have no recent check ins into GitHub and haven't communicated to [mailto:[email protected] [email protected]] about what's going on or notified us of calendar/time issues before hand, you can be fairly sure we will fail you at the next evaluation.
 +
* 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.
  
 
[[Category:GSoC]]
 
[[Category:GSoC]]

Latest revision as of 09:27, 5 April 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 discord 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 and clone Audacity before you apply.
    • During the GSoC project we expect fairly regular check ins of work in progress into your fork of Audacity. If you are accepted, start working but then miss a weekly status report, have no recent check ins into GitHub and haven't communicated to [email protected] about what's going on or notified us of calendar/time issues before hand, you can be fairly sure we will fail you at the next evaluation.
  • 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.