Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • Plasma Desktop Plasma Desktop
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 37
    • Issues 37
    • List
    • Boards
    • Service Desk
    • Milestones
  • Bugzilla
    • Bugzilla
  • Merge requests 53
    • Merge requests 53
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • PlasmaPlasma
  • Plasma DesktopPlasma Desktop
  • Merge requests
  • !1197

[docs] Add a codemap to help find your way around the code

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Bharadwaj Raju requested to merge work/bharadwaj/codemap-docs into master Oct 10, 2022
  • Overview 1
  • Commits 1
  • Pipelines 3
  • Changes 3

Describes the layout of this repo. This should help contributors navigate and and find what they're looking for much faster than just stumbling around.

I have experience with both contributing to and maintaining open-source projects. One of the lessons I’ve learned is that the biggest difference between an occasional contributor and a core developer lies in the knowledge about the physical architecture of the project. Roughly, it takes 2x more time to write a patch if you are unfamiliar with the project, but it takes 10x more time to figure out where you should change the code.

https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html

Also add a README and remove the outdated HACKING.

Edited Oct 10, 2022 by Bharadwaj Raju
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: work/bharadwaj/codemap-docs