Systers Community

Comment the code.

Prerequisite:

  • Be familiar with what PowerUp is and what it does. (Try running it!)
  • Complete the pull request task.
  • Make sure you're pulling/forking the latest code from the GSoC17 branch if you're working on the Android version. If you're working on iOS version use the develop branch of the project.

Steps:

  • Read this article to learn about best practices for adding comments to code.
  • Find a file in the PowerUp project that contains code.
  • Read through the entire file, understand what each line of code does and how it relates to the overall app.
  • If you think the comments in the file could be improved, do so! Add your own or make the existing ones more clear/consistent, which could mean removing comments or parts of comments.
  • If you think the comments in the file are perfect, find another file.
  • Since you're making working code more readable, you can refactor the code a little (by changing variable names, control flow structure, etc.). (Optional.)

Resources:

  • Tip: comments shouldn't state the obvious.
  • If you're unsure about the syntax for writing comments in the file you're editing, simply google "comments in " and you should find plenty of documentation.
  • Ask any questions or directions in #powerup on the Systers Open Source Slack.
  • Mention one of the mentors, such as myself (@dawnchandler), in the in the #powerup channel on the Systers Open Source Slack.

Work Submission:

  1. Submit a pull request to add your files with new comments to the project.

Task tags

  • systers
  • documentation
  • editing
  • comments
  • code

Students who completed this task

Valentun, Erika Tan, Sameer

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2017