Systers, an Anita Borg Institute Community

Adding Comments to the Existing Code for better understanding of functionalities. [PWR]

Prerequisite:

  • Setup the PowerUp project as given in the instruction in Readme

Task Description:

PowerUp was taken up as a project in GSoC'16. It is an android game app that has an embedded motive of education young girls and thus empowering them. The project code can be seen here

Task Steps:

  • Study the code and run the app on emulator to get a clear understanding of the functionalities
  • Read about the best Coding Practices online
  • Make appropriate comments to describe the methods and code
  • Push the commits to your fork and provide a link once you are done

Required:

As you work on this task, you should join and remain in #gci-general or #powerup on Systers Opensource Slack to get help, feedback, and guidance from mentors and other developers.

Keep in mind:

  • Copy-paste from Internet or any other source will be not tolerated and you are expected to submit your own work
  • Only work on your fork and your fork alone
  • Make logical comments and only where it is needed. Do no overwhelm the code file by excess of comments just for the sake of it, good code seldom needs explanation!
  • Follow Coding convention for making the comments
  • Also Document your work and understanding in the readme for your fork

Work Submission:

  • Link to the pushed commits in your forked repository.
  • Send a PR to systers:develop branch of powerup-android

Task tags

  • android
  • powerup
  • java

Students who completed this task

Farbod Salamat-Zadeh, Soham Sen, Erika Tan

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2016