-
Notifications
You must be signed in to change notification settings - Fork 0
Iteration 4 Plan
Pattadon L edited this page Sep 22, 2023
·
1 revision
Objective: To produce a high-quality app that can be easily installed and run by others.
-
List of Polls Improvement:
- Display all published polls, not just the newest ones.
- Sort polls by date, from newest to oldest.
-
Poll Questions Review and Revision:
- Ensure poll questions are written in good English.
- Ensure there are sufficient choices for each question.
-
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.
- Create a Markdown file named
-
Test Installation Instructions:
- Test the installation instructions by following them step by step using a fresh clone from GitHub.
-
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.
- Use
This iteration aims to improve the app's usability, documentation, and code quality, making it ready for others to easily install and run.