Difference between revisions of "Summer of Code/Students Guidelines"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Remove need to create a wiki user page as per discussion on -devel)
 
(15 intermediate revisions by 8 users not shown)
Line 1: Line 1:
Here we are enlisting some guidelines for students which are participating in GSoC with our project.
+
Here are some guidelines for students participating in this year's GSoC with ScummVM as their mentoring organisation:
  
* [http://sourceforge.net/account/registration/ Create an account on SF.net.]
+
* Get in contact with your project mentors and ensure they have all the pertinent information about you they may need (include useful info such as your primary time zone/location etc.).
* [http://freenode.net/faq.shtml#userregistration Register] your nick on FreeNode.net] (it's a good idea for your IRC and SF.net nicks to be similar/identical)
+
* [https://github.com/signup/free Create an account on Github.]
* Stay on IRC all hours when when you work on your task.
+
* [http://freenode.net/faq.shtml#userregistration Register your nick on FreeNode.net] (it's a good idea for your IRC, and Github nicks to be similar/identical).
* [https://lists.sourceforge.net/lists/listinfo/scummvm-devel Subscribe to the scummvm-devel mailing list.]
+
* Ideally stay connected to IRC and in [irc://irc.freenode.net/scummvm #ScummVM], it is often the quickest way to resolve issues with your mentor or get feedback from the larger team. If you can't stay connected to IRC please review the [http://logs.scummvm.org logs] frequently.
* Commit your code as soon as possible, preferably on a daily basis or more often.
+
* [http://lists.scummvm.org/listinfo/scummvm-devel Subscribe to the scummvm-devel mailing list] and briefly introduce yourself to the team. Tell them who you are, what you are going to work on, where your blog is, what your IRC nick is.
* Reflect your progress in a blog (if you don't have one already, try [http://www.blogger.com/ Blogger], [http://wordpress.com Wordpress] (you can also install it yourself, get it from http://wordpress.org/), ...).
+
* Read and follow our [[Code Formatting Conventions]].
* Create your user page on our Wiki and give a brief overview on what you are working on. However, your blog is the main place to write about your progress.
+
* Commit your code as soon as possible, preferably on a daily basis or more often. Our preferred approach to code commits is 'commit early, commit often'. Remember that your code is one of the key project deliverables so the more code we can see the easier it is to judge progress and help ensure that everything goes smoothly.
 +
* We use [http://git-scm.com/ Git] as our version management system. Please refer to the online [http://git-scm.com/documentation documentation] and the book [https://git-scm.com/book Pro Git] for instructions on how to use Git.<br>[[Git_tips|This]] and [[GIT_Migration|this]] might also be useful to refer to.<br>Please also note that all students will be working off of individual [http://progit.org/book/ch3-0.html branches] of ScummVM, not the main development code (master).<br>We host currently code on [https://github.com/scummvm Github], but [https://bugs.scummvm.org our own bugtracker] is used for bug tracking, patch tracking etc.
 +
* Reflect your progress in a weblog. It's fine to reuse your existing weblog, if you have one, with a "ScummVM GSoC" category or so. If you don't have one already, try [http://www.blogger.com/ Blogger], [http://wordpress.com Wordpress] (see also http://wordpress.org), [http://www.movabletype.com/ Movable Type], ... Start blogging very soon, even if it's just a "First post" so we can have a definite URL and we can subscribe to it.

Latest revision as of 23:43, 28 May 2018

Here are some guidelines for students participating in this year's GSoC with ScummVM as their mentoring organisation:

  • Get in contact with your project mentors and ensure they have all the pertinent information about you they may need (include useful info such as your primary time zone/location etc.).
  • Create an account on Github.
  • Register your nick on FreeNode.net (it's a good idea for your IRC, and Github nicks to be similar/identical).
  • Ideally stay connected to IRC and in #ScummVM, it is often the quickest way to resolve issues with your mentor or get feedback from the larger team. If you can't stay connected to IRC please review the logs frequently.
  • Subscribe to the scummvm-devel mailing list and briefly introduce yourself to the team. Tell them who you are, what you are going to work on, where your blog is, what your IRC nick is.
  • Read and follow our Code Formatting Conventions.
  • Commit your code as soon as possible, preferably on a daily basis or more often. Our preferred approach to code commits is 'commit early, commit often'. Remember that your code is one of the key project deliverables so the more code we can see the easier it is to judge progress and help ensure that everything goes smoothly.
  • We use Git as our version management system. Please refer to the online documentation and the book Pro Git for instructions on how to use Git.
    This and this might also be useful to refer to.
    Please also note that all students will be working off of individual branches of ScummVM, not the main development code (master).
    We host currently code on Github, but our own bugtracker is used for bug tracking, patch tracking etc.
  • Reflect your progress in a weblog. It's fine to reuse your existing weblog, if you have one, with a "ScummVM GSoC" category or so. If you don't have one already, try Blogger, Wordpress (see also http://wordpress.org), Movable Type, ... Start blogging very soon, even if it's just a "First post" so we can have a definite URL and we can subscribe to it.