0

I'm inspired by Conventional Commits, and would like to add some more structure elements for writing projects, e.g. documentations or personal or organizational knowledge management system. I'm thinking of these:

  • title: for changes in project title
  • structure: for changes in project folder structure
  • fileA/B/C: for changes in an important file (to avoid to tediously create many submodules for tracking many individual files)

I'm also inspired by Semantic Versioning, and come up with an idea to semantic versioning the projects. Here is the idea:

Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when root folder has significant changes
  2. MINOR version when 1st-level folders has significant changes
  3. PATCH version when 2st-level folders has significant changes

What is significance is up to you. For me, it may be adding or removing a file or folder. Renaming without changing the idea much may be denoted with a letter after (i.e. 33a3b). If your root folder's structure is already stable before you apply the versioning, you foresee that it will be stable in a far future, then you can skip the MAJOR version if you want.

This idea can be generalize to any hierarchical structure, not just limited to folder structure. For example, a hierarchical graph.

Is there anything I should notice when applying these ideas?

4
  • FYI, in Git you can add tags with: git tag -a v1.3 -m "tag label here". If you are new with Git, you can start with Learn Git Branching and Picturing Git: Conceptions and Misconceptions - BiTE Interactive. It really helps me.
    – Ooker
    Commented Sep 10, 2023 at 17:44
  • for now I'm writing organizational knowledge project/internal wiki via Obsidian
    – Ooker
    Commented Sep 11, 2023 at 3:13
  • Having datatime in the filename is not enough to have a summary of what changes in the files, structures and general intentions. I don't really need to go back to earlier versions or have different branches.
    – Ooker
    Commented Sep 11, 2023 at 6:06
  • having summaries of changes outside the file can help you querying it easier. You don't have to open the file. You can diff and blame. You can push to GitHub and make use of actions to build a website or trigger tasks
    – Ooker
    Commented Sep 11, 2023 at 6:38

0

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Browse other questions tagged or ask your own question.