Differences

This shows you the differences between two versions of the page.

--- projects:projects [2026/05/31 01:26] – jhagstrand
+++ projects:projects [2026/06/20 01:37] (current) – [Coding Style] jhagstrand
@@ Line 19: / Line 19: @@
 [[projects:minimal:minimal]] - html, css, javascript for a minimal web app
 === Apps ===
-[[projects:home:home]] - new home page
+[[projects:homepage:homepage]] - homepage for voyc.com
+[[projects:pokerface:pokerface]] - facial expressions of artificial feelings
+[[projects:geo:geo]] - geopolitics map drawing
 [[projects:curriculum:curriculum]] - voycipedia
@@ Line 56: / Line 61: @@
 [[projects:timeline:timeline]] - timeline
-[[https://docs.google.com/spreadsheets/d/19pIRXgSPT8AFUTCPh-eTPc8Ej9RInxtj518fo-t2HVs/edit?usp=sharing | projects checklist]]
+[[projects:voyc:voyc]] - leftover from when geo/global was voyc.com
+[[https://docs.google.com/spreadsheets/d/1Hs1h9R91J8e3biNyIzN-aX_iER-cJ1zTMMGI4BeC-IA/edit?gid=2023137882#gid=2023137882 | My Drive -> sync -> dev -> webapps -> projects checklist sheet]]
+[[https://drive.google.com/drive/folders/0ByidsAQcVcUUei0wc1lpVWlfUFU?resourcekey=0-22REggHl5xt3oBQw_syh0w | My Drive -> sync -> dev -> webapps]]
 =====Developer Guidelines=====
+==== Coding Style ====
+Coding style:
+  * use the tab character to indent
+  * use unix line-endings
+javascript
+php
+python
+==== File Organization ====
+  project/                        ← git root
+    .env
+    config.php
+    config-example.php
+        html/                   ← docroot - index.html
+                svc/            ← webservice stubs, php or python
+                js/             ← project-specific javascript code
+                        lib/    ← generic javascript code
+                css/            ← project-specific css styles
+                        lib/    ← generic css styles
+        php/                    ← project-specific php code
+                lib/            ← generic php code
+        python/                 ← project-specific python code
+                lib/            ← generic python code
+        db/
+            schema.sql
+            seed.sql
+            reset.sh
 ====.gitignore====
@@ Line 67: / Line 109: @@
   css.min
   index.php
+  RELEASES.md
+  .aider*
+  config.php
 ==== Duplicate Content ====
@@ Line 169: / Line 213: @@
   git pull origin master
   git push gitlab master
+==== voyc release management ====
+Trends in release management as of 2026.
+  * 50/72 rule. A commit message has three lines (title, blank, body).  The first line is the title and it is 50 characters long.  The second line is blank.  The third and subsequent lines make up the body; they are bullets, and they are 72 characters long.  [Ed. title is my word.  Other people say description or subject.]
+  * Conventional Commits.  The first line of the commit message is prefixed with a category: feat, fix, perf, style, refactor, test, build, chore.  This rule overrides an earlier rule that the title should be capitalized.
+  * Semantic Versioning.  Each release is numbered major.minor.patch, like 14.3.5. When a development group breaks backward compatibility, now a normalized behavior, they assign a new major number.  When a bug is discovered that is so dangerous it must be fixed immediately, they release a patch.
+{{https://en.wikipedia.org/wiki/Conventional_Commits_Specification | more on Conventional Commits}}\\
+[[https://semver.org/ | more on Semantic Versioning]] \\
+[[https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | Tim Pope: A Note About Git Commit Messages, 2008.]]\\
+At voyc we use these above trends in commit messages and tag messages.  The log of commit messages is detailed for developers.  The list of tag messages is more abstract, for users and managers.  Release histories are generated by script from the list of tag messages.
+At deployment, a file named RELEASES.md is generated from the tag messages by a script.  It is not committed; it listed in .gitignore.
+[[..:git | more about log and tag]]
+  # All tags with their full messages, most recent first
+  git tag -l --sort=-version:refname | xargs -I{} git show {} --no-patch --pretty=format:"%tag %*%(tag)%n%s%n%b%n---"
+  git for-each-ref --sort=-version:refname --format="%(refname:short)%0a%(contents)%0a---" refs/tags
+Practices:
+  * Commits made only in feature branch.  Never on the master branch.
+  * We let aider auto-commit every change.
+  * At merge, we generally keep the detailed commits, but squash is optional.
+  * The commit log is for developers.
+  * At release, we create a tag, observing SemVer, with hand-written message.
+  * Public release history is generated from the tag messages.
+  * Conventional commits types are used only on the commit messages, not the tag messages.
+==== One-time Fix Privacy in Log ====
+  # in laptop dev repo
+  git checkout fixlog
+  git filter-repo --mailmap .mailmap --force
+  git checkout master
+  git merge fixlog
+  git branch -d fixlog
+  git push origin master --force --tags   # push to bare repo
+  git push gitlab master --force --tags   # push to gitlab
+==== Start Branch ====
+  git branch peaceful
+==== Save Work ====
+  # save work
+  git checkout peaceful
+  git push origin peaceful     # push feature branch to bare repo
+==== End Branch ====
+  git checkout master
+  git merge --squash peaceful
+  git commit -m 'squashed hand-written commit message'
+  git branch -D peaceful    # after squash the big -D force is required
+  git push origin master     # push master to bare repo
+  git push origin --delete peaceful  # delete feature branch from bare repo
+==== Deploy ====
+  git tag v0.2.0 -m'...'  # fancy hand-written tag message will become part of release history
+  git push origin master --tags
+  git push gitlab master --tags
+  # in production webserver
+  git fetch origin
+  git reset --hard origin/master
+  git push gitlab master --tags