Skip to content

🟠 Take Ownership of Code Files

Add your name and date to the code files.

Step 1. Review the Source Folder

In VS Code Explorer, open the src folder. A typical Python project contains a package folder directly below src. Explore the Python files under src (they will have a .py extension).

See Project Structure.

Step 2. Review the Notebooks Folder (if used)

In VS Code Explorer, look for notebooks. Some projects may include Jupyter notebook code files. Explore any files under notebooks (they may have a .ipynb extension).

Step 3. Check for a Marimo reactive app.py (if used)

In VS Code Explorer, look for a file named app.py. Some projects may include marimo notebook code files. Explore any files under notebooks (they have a .py extension). They may also as app.py in other locations. Marimo is a new technology and not all projects will have them.

Step 4. Take Ownership of the Code Files

Review the header or docstring in each code file.

  • Update or add an author entry with your name or alias.
  • Include a date, such as YYYY-MM.

Taking ownership is important. Doing so creates the first changes, and typically should not break the project. If it does, you can always copy from the example again and start fresh.

Step 5. Identify What to Customize

Consider your new problem and data.

  • Which functions can be reused?
  • Which data inputs need to change?
  • Which calculations or techniques need to change?
  • Which outputs should describe your custom problem?
  • What additional functions might be needed?

IMPORTANT: Keep the existing Python package name and folder structure unless you have a specific reason to change them.

Changing the GitHub repository name does not require renaming Python packages, modules, or imports.

You will progressively implement your custom solution in Workflow D.

Verification

  • [ ] I can locate code files in a standard project.
  • [ ] I understand how files and functions work together.
  • [ ] I am willing to read and try to understand source code.
  • [ ] I can consider what might need to change for my custom problem.
  • [ ] The author/date information identifies areas I intend to contribute.

◄ Back to 🟠 Workflow C