Skip to content
New issue

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

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

Already on GitHub? # to your account

USER STORY: Python code quality #22

Closed
25 of 26 tasks
blahosyl opened this issue Aug 16, 2024 · 0 comments
Closed
25 of 26 tasks

USER STORY: Python code quality #22

blahosyl opened this issue Aug 16, 2024 · 0 comments
Assignees
Labels
e: code quality Epic: Code quality p: must have Priority: Part of the MVP

Comments

@blahosyl
Copy link
Owner

blahosyl commented Aug 16, 2024

As a Developer,

I want my Python files to be well-structured and -commented,

so that my code is easy to audit and maintain

Acceptance Criteria

  1. All self-written Python files in the project have classes and methods with appropriate docstrings
  2. All self-written Python files in the project have inline comments explaining areas that require particular attention or have proven to be common stumbling blocks
  3. All self-written Python files in the project are organized into logical and well-commented blocks
  4. All self-written Python files in the project have commented-out code removed
  5. Comment coverage errs on the side of "more is more", as befits a neurodivergent coder's first-time Django ReST Framework project.

Files

api-task-manager/

  • permissions.py
  • serializers.py
  • settings.py
  • urls.py
  • views.py

comments/

  • admin.py
  • models.py
  • serializers.py
  • tests.py
  • urls.py
  • views.py

profiles/

  • admin.py
  • models.py
  • serializers.py
  • urls.py
  • views.py

tasks/

  • admin.py
  • models.py
  • serializers.py
  • urls.py
  • views.py

watchers/

  • admin.py
  • models.py
  • serializers.py
  • urls.py
  • views.py
@blahosyl blahosyl self-assigned this Aug 16, 2024
@blahosyl blahosyl moved this to Backlog in Task Manager Aug 16, 2024
@blahosyl blahosyl changed the title USER STORY: Python comment coverage & structure USER STORY: Python code quality Aug 16, 2024
@blahosyl blahosyl added p: must have Priority: Part of the MVP e: code quality Epic: Code quality labels Aug 16, 2024
@blahosyl blahosyl moved this from Backlog to In Progress in Task Manager Aug 16, 2024
blahosyl added a commit that referenced this issue Aug 16, 2024
blahosyl added a commit that referenced this issue Aug 16, 2024
blahosyl added a commit that referenced this issue Aug 19, 2024
blahosyl added a commit that referenced this issue Aug 19, 2024
blahosyl added a commit that referenced this issue Aug 19, 2024
@blahosyl blahosyl moved this from Todo to Done/Won't do in Task Manager Aug 19, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
e: code quality Epic: Code quality p: must have Priority: Part of the MVP
Projects
Status: Done/Won't do
Development

No branches or pull requests

1 participant