Skip to content

Project Management — Folder Structure

  1. Create an issue in your GitLab project.
  2. Copy and paste the checklist below into the issue description.
  3. Work through the checklist.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
- [ ] **Design your initial folder layout.***Create a structure that fits your project’s purpose (e.g. separate source, documentation, test, and resource files). Commit the first version to Git.*

- [ ] **Question:** Why did you choose this structure?  
  → *Explain your reasoning briefly in the main README under “Project Structure” (e.g. ease of navigation, separation of concerns).*

- [ ] **Add minimal placeholders** (`README.md`, `.gitkeep`, or sample files) to illustrate planned content in each folder.  
  💡 *Remember: Git does not store empty directories — you need a placeholder file if the folder should appear in the repo.*

- [ ] **Question:** Can a new team member find what they need without asking you?  
  → *Ask a teammate or peer to navigate the repo and record their feedback in an issue labeled “onboarding feedback.”*

- [ ] **Document where things belong.***In your README or wiki, describe the purpose of each top-level folder (e.g. `/docs – documentation and guides`).*

- [ ] **Set up and commit a `.gitignore`.***Exclude generated or temporary files (e.g. `__pycache__`, `build/`, `.idea/`, etc.). You can generate a starting template at [toptal.com/developers/gitignore](https://www.toptal.com/developers/gitignore). Add a short note or issue comment if you made custom modifications.*

- [ ] **Question:** How will your structure evolve?  
  → *Note expected changes (e.g. adding `/api`, `/frontend`, `/tests`) in an issue labeled “future structure plan.”*