Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance/user-others #6

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from
Open

Enhance/user-others #6

wants to merge 18 commits into from

Conversation

KafayatYusuf
Copy link
Owner

What type of PR is this?

Check all applicable

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (please specify)

Related Issue :

Gives a detailed overview of what the API is about

What does this PR do?

Improves the documentation quality of the central file (main.py) by introducing the followings:

  • Summarized what the API is all about
  • Added a welcome message
  • Added color console

Consideration :

Adding a summary gives you an overview of what the API does

How to test ?

Clone this repository
Install Docker with this link Docker Installation Guide
Visit this link to view the Raw Data API Documentation

Screenshots :

image
Please provide screenshots of the change.

Checklists:

Checklist before requesting review :

  • πŸ“– Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
  • πŸ‘·β€β™€οΈ Create small PRs. In most cases, this will be possible.
  • βœ… Provide tests for your changes.
  • πŸ“ Use descriptive commit messages.
  • πŸ“— Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?

organizing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant