3.6 KiB
Project instructions
Reuse shared code
Reuse existing shared code wherever possible. When the same behavior, component, or logic is needed in two or more places, extract it into a shared component or function and use it at every applicable call site.
Mandatory Wiki updates for every release
A release is not complete until the published project Wiki reflects that release. Apply this rule to every release, including patch releases and bug-fix-only releases.
Wiki: https://gitea.hrynco.com/hrynco/hrynco-kswitcher/wiki
- Confirm the release version from
CMakeLists.txt, the release tag andRelease/README.md. Use the complete version (for example,v0.6.17) and preserve the release channel rules inREADME.md. - Update the latest-version information on the Wiki home pages and any other pages identifying the current release. Update release dates, download links and upgrade instructions where needed. Keep historical version references and compatibility bridge instructions when they are still accurate.
- Review the changes since the last release documented in the Wiki, not just the immediately preceding release. Bring the relevant feature pages up to date with the shipped behavior: new, changed and removed functionality, settings, shortcuts, defaults, limitations and troubleshooting. Update screenshots or examples when they no longer match the application. For bug-fix-only releases, check whether documented behavior or workarounds need correction; do not invent feature changes.
- Keep English and Ukrainian pages synchronized, including
HomeandHome-uk, and preserve working translation and navigation links. - Publish the Wiki changes as part of the release workflow. Read back the published pages and verify the current version, feature descriptions, download links and translation links. A local Wiki edit alone is not enough.
- In the release completion report, link the updated Wiki pages and summarize the documentation changes. If Wiki publication or verification is blocked, explicitly report the outstanding step and do not claim the release workflow is complete.
Updating only the release notes or changing only the Wiki version number does not satisfy this rule; the current functionality must also be reviewed.
Gitea issue authentication
For Gitea issue API requests from this checkout, use the project token stored
with Windows DPAPI in kswitcher-gitea-token.dpapi under the directory returned
by git rev-parse --absolute-git-dir. Read it with PowerShell
Get-Content -LiteralPath $tokenFile | ConvertTo-SecureString and use it only
for the Gitea authorization header. Keep the token out of tracked files and
command output.
KSwitcher Files UI
Before changing the file manager UI, read FILES-UI.md. Reuse the shared dialog rendering and layout helpers. Update the document when an agreed UI requirement changes.
Link changes to Gitea issues
For commits that implement a Gitea issue, include Refs #<number> in the
commit message body. In a pull request, use Fixes #<number> when merging
fully resolves the issue, or Refs #<number> when the work is partial.
Use the existing issue for follow-up commits on the same change.
Assign each new issue to the KSwitcher project board using its default column, and verify that the issue appears on the board.
Use Markdown headings, lists, and bold emphasis to make issue descriptions easy to scan. Embed relevant screenshots as Markdown images using their Gitea attachment URLs, and verify that the images render in the description.