book-openBefore we Start

circle-exclamation

KEEP IT SIMPLE!

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.

Markdown Basic Syntax Guide
  • Compose a README.md: Write a concise README.md file detailing how to execute the application and any required dependencies.

Example:

Install the required dependencies:

  • Prepare requirements.txt: Include a requirements.txt file to facilitate the installation process for users.

Example:

  • 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.

Last updated