Difference between revisions of "GSoC FAQ"

From Audacity Wiki
Jump to: navigation, search
(Oops I should have previeweed.)
(Question on what committing to a feature means.)
Line 49: Line 49:
 
* '''Q: Where can I find out about the architecture of Audacity?'''
 
* '''Q: Where can I find out about the architecture of Audacity?'''
 
* '''A:''' Look on this Wiki in [[ArchitecturalDesign]] and then perhaps at the pages in the [[:Category:For Developers|For Developers]] category.
 
* '''A:''' Look on this Wiki in [[ArchitecturalDesign]] and then perhaps at the pages in the [[:Category:For Developers|For Developers]] category.
 
 
* '''Q: I'm pressed for time.  Is there a simple way to keep up-to-date with what's going on with Audacity and GSoC?'''
 
* '''A:''' Yes. Bookmark {{external|1=http://audacityteam.org/wiki/index.php?title=GSoC_News_and_Tips}}. We'll try and post deadlines and other important things you need to know there as they happen. That page will also have some Handy Hints to help your GSoC experience with us go smoothly. Add your own tips there if you know a good one! 
 
  
  
Line 61: Line 57:
 
* '''Q: Am I good enough for GSoC?'''
 
* '''Q: Am I good enough for GSoC?'''
 
* '''A:''' Convince us you are!  If you give us evidence that you've compiled Audacity and then made some modification to Audacity you're ahead of most people.
 
* '''A:''' Convince us you are!  If you give us evidence that you've compiled Audacity and then made some modification to Audacity you're ahead of most people.
 +
 +
 +
* '''Q: How do I fix this compiler error that I see....'''
 +
* '''A:''' Check our [[Developer Guide#Platform Specific Guides|compilation instructions]] and the Windows and Mac compile.txt files in the source code if you have not already, then '''talk with us''' on audacity-devel.  Asking questions about getting the Audacity compiler going won't harm your chances.  It shows we don't need to worry about you getting stuck and not letting us know.
  
  
 
* '''Q: I want to tackle this HARD problem from your ideas list.  Is it too hard for me?  Is it even possible?'''
 
* '''Q: I want to tackle this HARD problem from your ideas list.  Is it too hard for me?  Is it even possible?'''
 
* '''A:''' Only you can tell if its too hard for you.  We believe the basic idea is perfectly achievable by an advanced student.  Talk it through with us, and spend time understanding the problem.  Convince yourself you can do it, so you know how much to offer to do, and then convince us you can.  Beware of not giving us evidence that you can compile and modify Audacity whilst you focus on the harder stuff.  Beware of not giving us evidence that you can interact with our community.   
 
* '''A:''' Only you can tell if its too hard for you.  We believe the basic idea is perfectly achievable by an advanced student.  Talk it through with us, and spend time understanding the problem.  Convince yourself you can do it, so you know how much to offer to do, and then convince us you can.  Beware of not giving us evidence that you can compile and modify Audacity whilst you focus on the harder stuff.  Beware of not giving us evidence that you can interact with our community.   
 +
 +
 +
* '''Q: I would like to do THIS idea from your ideas page.  Has it already been taken?  Is there a mentor for it?'''
 +
* '''A:''' Until the application deadline there is no such thing as a project being 'taken'.  With most of the ideas it is possible to run two projects on the same general idea, with different people coding different aspects.  Avoid the risk entirely by coming up with your own idea, or submit your plan early and rely on discussion with mentors to find a way forward.  If an excellent proposal arrives that we don't have a mentor/specialist for in house, we'll do our best to find a creative solution.  It could mean a mentor in Audacity and an advisor from some other open source group.
  
  
Line 73: Line 77:
 
* '''Q: I'm a graduate student and I'm doing research in Audio/DSP.  Can I propose this extension to Audacity which sounds awfully like the brief for my academic research project?'''
 
* '''Q: I'm a graduate student and I'm doing research in Audio/DSP.  Can I propose this extension to Audacity which sounds awfully like the brief for my academic research project?'''
 
* '''A:''' We don't have a problem with that.  If it progresses your research and at the same time does enough good for general users of Audacity, that can be win-win.  You will need to contact us early.  You will need a very clear focus on things that benefit users.  If you're in the "research stratosphere", don't forget to give us evidence that you can compile and modify Audacity and be sure to give us evidence that you can interact with our community.   
 
* '''A:''' We don't have a problem with that.  If it progresses your research and at the same time does enough good for general users of Audacity, that can be win-win.  You will need to contact us early.  You will need a very clear focus on things that benefit users.  If you're in the "research stratosphere", don't forget to give us evidence that you can compile and modify Audacity and be sure to give us evidence that you can interact with our community.   
 +
 +
 +
* '''Q: I've posted an application using the GSoC Student Web app, and I'm being asked to clarify what features I'm committing to and what features are optional 'if time permits'.  What does it mean to commit to a feature?  Does it mean I'll fail if I don't deliver a feature I commit to? '''
 +
* '''A:''' It's ultimately the mentors who decide whether a project is a success/failure. At the application stage we need clarity about what you expect to achieve. If we failed a student who committed to a feature and then didn't deliver, it would usually be because they'd also claimed skills/experience they didn't actually have, or else had gone AWOL during GSoC.
  
  
Line 81: Line 89:
  
 
* '''Q: Do I really need a gmail account?'''
 
* '''Q: Do I really need a gmail account?'''
 +
* '''A:''' This is our additional requirement.  Other mentoring organisations don't require it and it's not required by Google.  If we send an e-mail to [email protected] and we don't hear back from you, we want to reduce the risk of it being down to a dodgy ISP.  If you're blaming gmail for a failure to communicate, Google have the option of looking into it if we ask.  It's presumably one of the reasons that Google requires it of mentors.
  
* '''A:''' This is our additional requirement.  Other mentoring organisations don't require it and it's not required by Google.  If we send an e-mail to [email protected] and we don't hear back from you, we want to reduce the risk of it being down to a dodgy ISP.  If you're blaming gmail for a failure to communicate, Google have the option of looking into it if we ask.  It's presumably one of the reasons that Google requires it of mentors.
 
  
 +
* '''Q: I'm pressed for time.  Is there a simple way to keep up-to-date with what's going on with Audacity and GSoC?'''
 +
* '''A:''' Yes. Bookmark {{external|1=http://audacityteam.org/wiki/index.php?title=GSoC_News_and_Tips}}. We'll try and post deadlines and other important things you need to know there as they happen. That page will also have some Handy Hints to help your GSoC experience with us go smoothly. Add your own tips there if you know a good one! 
  
* '''Q: How do I fix this compiler error that I see....'''
 
* '''A:''' Check our [[Developer Guide#Platform Specific Guides|compilation instructions]] and the Windows and Mac compile.txt files in the source code if you have not already, then '''talk with us''' on audacity-devel.  Asking questions about getting the Audacity compiler going won't harm your chances.  It shows we don't need to worry about you getting stuck and not letting us know.
 
  
  

Revision as of 22:30, 5 April 2008

This page answers some questions asked by potential GSoC students posted to our Summer of Code e-mail address  and to our audacity-devel mailing list .
http://code.google.com/soc/2008/  has comprehensive details of the current GSoC program. Some questions we have been asked are also answered there, though not always on their FAQ pages.



Basic questions on GSoC and the application process

  • What level of technical expertise is required to participate in GSoC?

The level that could reasonably be expected of better than average computer science degree students after their first year. Realistically, given that GSoC is fairly competitive, we'd regard the minimum programming skill to be such that at least one programming project of 1000+ lines should have been completed as part of coursework. Applicants should mention at least one significant program they have completed on their application.

We're not expecting students to already be familiar with the speciality of sound processing for Audacity work. However students should have some familiarity with writing GUI code or they will be at a distinct disadvantage.


  • What sort of projects can be chosen?

The organisations and projects that were offered in 2007 can be found here:

http://code.google.com/soc/2007 

For Audacity we welcome new ideas that may enhance the program's functionality. Some suggestions can be found on our GSoC ideas page.


  • What is the role of mentoring organizations?

See the Google pages for precise details.
- We select the applications we like the best.
- We provide a mentor. The mentor is there to advise on implementation choices, making sure that the student has the information they need.
- We, particularly the mentor, evaluate the work and confirm to Google that the student has done the work satisfactorily, which is the basis on which Google pays the student.


  • How do I make a "good" application?

Whatever mentoring organization you choose, the best way is to get in contact with its developers and discuss what you would like to do as a project with them. Do this well in advance of sending in your application. The results of that discussion will lead to a much stronger application. To discuss your ideas with the Audacity developers, please subscribe to our developers' mailing list .

Your application will also be stronger if you have already tried using the Audacity codebase. If you have compiled Audacity and made some small experimental change, that gives us confidence that you will be able to do more. There's more about writing a good GSoC application here.


More detailed questions

These are brief answers to some of the more detailed questions we've answered on audacity-devel mailing list. Have a look at our audacity-devel archive  to check all that's been asked and answered, then write to -devel list if you still need help.


  • Q: What is Cleanspeech?
  • A: See this page  of our next Manual  (still in draft) for this and similar questions about the Audacity interface. Remember too, Google is your friend, look there also before asking :-)


  • Q: Where can I find out about the architecture of Audacity?
  • A: Look on this Wiki in ArchitecturalDesign and then perhaps at the pages in the For Developers category.


  • Q: I don't know wxWidgets. Is that a problem?
  • A: wxWidgets can be learned very quickly. See their documentation , including a 700-page book: Cross-Platform GUI Programming with wxWidgets  (this is also available as a PDF download ). If you've not used wxWidgets before, spend some time getting familiar with it so that knowledge shows in your application. If you're unsure, talk it over with us.


  • Q: Am I good enough for GSoC?
  • A: Convince us you are! If you give us evidence that you've compiled Audacity and then made some modification to Audacity you're ahead of most people.


  • Q: How do I fix this compiler error that I see....
  • A: Check our compilation instructions and the Windows and Mac compile.txt files in the source code if you have not already, then talk with us on audacity-devel. Asking questions about getting the Audacity compiler going won't harm your chances. It shows we don't need to worry about you getting stuck and not letting us know.


  • Q: I want to tackle this HARD problem from your ideas list. Is it too hard for me? Is it even possible?
  • A: Only you can tell if its too hard for you. We believe the basic idea is perfectly achievable by an advanced student. Talk it through with us, and spend time understanding the problem. Convince yourself you can do it, so you know how much to offer to do, and then convince us you can. Beware of not giving us evidence that you can compile and modify Audacity whilst you focus on the harder stuff. Beware of not giving us evidence that you can interact with our community.


  • Q: I would like to do THIS idea from your ideas page. Has it already been taken? Is there a mentor for it?
  • A: Until the application deadline there is no such thing as a project being 'taken'. With most of the ideas it is possible to run two projects on the same general idea, with different people coding different aspects. Avoid the risk entirely by coming up with your own idea, or submit your plan early and rely on discussion with mentors to find a way forward. If an excellent proposal arrives that we don't have a mentor/specialist for in house, we'll do our best to find a creative solution. It could mean a mentor in Audacity and an advisor from some other open source group.


  • Q: I've not written a program with more than 1000+ lines before. Is that a problem?
  • A: Yes. Talk it over with us. There may be a way forward all the same. It's harder for less experienced people to get a slot, but it still should be possible. If you're relatively inexperienced and also leaving contacting us to the last possible moment too, there's no chance at all.


  • Q: I'm a graduate student and I'm doing research in Audio/DSP. Can I propose this extension to Audacity which sounds awfully like the brief for my academic research project?
  • A: We don't have a problem with that. If it progresses your research and at the same time does enough good for general users of Audacity, that can be win-win. You will need to contact us early. You will need a very clear focus on things that benefit users. If you're in the "research stratosphere", don't forget to give us evidence that you can compile and modify Audacity and be sure to give us evidence that you can interact with our community.


  • Q: I've posted an application using the GSoC Student Web app, and I'm being asked to clarify what features I'm committing to and what features are optional 'if time permits'. What does it mean to commit to a feature? Does it mean I'll fail if I don't deliver a feature I commit to?
  • A: It's ultimately the mentors who decide whether a project is a success/failure. At the application stage we need clarity about what you expect to achieve. If we failed a student who committed to a feature and then didn't deliver, it would usually be because they'd also claimed skills/experience they didn't actually have, or else had gone AWOL during GSoC.


  • Q: I want to send in some source code too, along with my application. Do I send it with the application or do I link to it?
  • A: Clear bullet points are often better than pseudocode to specify what the code will do. Real code should usually be hyper-linked to, and in your application make sure to tell us if it already runs in Audacity or is a separate program. We currently have some questions for Google about content that is linked to - can we access it when we browse the mentor app, or does it change after the application deadline - so use it for evidence to back up your claims on your proposal, rather than for content that absolutely has to be read for your proposal to have a good chance.


  • Q: Do I really need a gmail account?
  • A: This is our additional requirement. Other mentoring organisations don't require it and it's not required by Google. If we send an e-mail to [email protected] and we don't hear back from you, we want to reduce the risk of it being down to a dodgy ISP. If you're blaming gmail for a failure to communicate, Google have the option of looking into it if we ask. It's presumably one of the reasons that Google requires it of mentors.


  • Q: I'm pressed for time. Is there a simple way to keep up-to-date with what's going on with Audacity and GSoC?
  • A: Yes. Bookmark http://audacityteam.org/wiki/index.php?title=GSoC_News_and_Tips . We'll try and post deadlines and other important things you need to know there as they happen. That page will also have some Handy Hints to help your GSoC experience with us go smoothly. Add your own tips there if you know a good one!