madhuakula/aws-iam-analyser

Bad Naming Convention

Open

#7 opened on May 29, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (2 forks)github user discovery
help wanted

Repository metrics

Stars
 (10 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Across the functions, it's mostly output and response. What is the excepted output, what is the response?

Variables should be better declared to fit their functionality and the purpose being served.

  • Functions should return something if they are GETs
  • Variables should be more descriptive

Contributor guide

Research direction
Rename variables like 'output' and 'response' to more descriptive names based on their specific purpose in the code. Ensure that GET functions return the relevant data.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85