Google Code-in

Introduction

The Mentorship Relation API resources don't have enough doc strings to reflect their usage or purpose on Swagger UI. By adding doc strings under the respective REST methods, you'll be updating the Swagger UI at the same time. E.g.: POST /login has a full description on Swagger.

Prerequisite:

• Have a GitHub account
• Know how to use git
• Setup and run the project on your local development environment

Steps:

• Create a copy of the project into your account GitHub by forking systers/mentorship-backend project.
• Clone the project onto your local development environment
• [Optional] Create a branch to make your changes
• Create doc strings for every resource/endpoint of Mentorship Relation API. Hint: the file where you might have to do these changes is app/api/resources/mentorship_relation.py file.
  • be mindful to explain important parts of the logic behind the APIs, for example if an endpoint is only available to the creator of a request.
• Commit your change through the interface using our Commit message Style Guide.
• Submit a Pull Request, targeting gci-dev branch, following the template provided in the description.

Resources:

• If you need help or get lost, post a response to our questions topic in our #gci stream.
• Pull request template at this link.
• Commit message Style Guide can be found here.
• How to fork, clone and setup remotes the project into your account wiki page can be found here.

Work Submission:

Submit a link to Pull Request (PR) created with the change.