Skip to content

Iteration 4 Plan

Pattadon L edited this page Sep 22, 2023 · 1 revision

Goal for Iteration 4:

Objective: To produce a high-quality app that can be easily installed and run by others.

Features:

  1. List of Polls Improvement:

    • Display all published polls, not just the newest ones.
    • Sort polls by date, from newest to oldest.
  2. Poll Questions Review and Revision:

    • Ensure poll questions are written in good English.
    • Ensure there are sufficient choices for each question.
  3. Installation Instructions:

    • Create a Markdown file named Installation.md containing detailed instructions on how to install and configure the app.
    • Include steps such as cloning or downloading the code from GitHub, creating a virtual environment, installing dependencies, setting values for externalized variables, running migrations, running tests, and installing data from data fixtures.
    • Add a link to Installation.md in the README.
    • Ensure that Installation.md is placed in the source repository, making it easy for users to access the installation instructions.
  4. Test Installation Instructions:

    • Test the installation instructions by following them step by step using a fresh clone from GitHub.
  5. Code Cleanup:

    • Use flake8 to identify coding issues, incorrect docstrings, and unused imports.
    • Allow exceptions for autogenerated Django code (migrations, mysite files), lines in models up to 100 characters long, and minor issues like missing docstrings in __init__.py files.

Milestone:

This iteration aims to improve the app's usability, documentation, and code quality, making it ready for others to easily install and run.

Clone this wiki locally