Before we Start
Last updated
Last updated
This project is about project management. You do NOT need to have enormously complicated programs to succeed here.
You need to take the following steps to ensure effective documentation and version control:
Create Markdown Files: Document the development process in PROJECT_DEVELOPMENT.md
within your GitHub repository. Ensure clarity by adding comments to your code explaining each function and major steps.
Compose a README.md: Write a concise README.md file detailing how to execute the application and any required dependencies.
Install the required dependencies:
Prepare requirements.txt: Include a requirements.txt file to facilitate the installation process for users.
Commit Changes: Every time changes are made to the code or documentation, use a GitHub commit to describe the modifications. A scaffold will be provided to guide your reflective writing.