Skip to content

Conversation

@navidpadid
Copy link
Owner

@navidpadid navidpadid commented Jan 22, 2026

This pull request introduces several new documentation files and an automated release workflow for the kernel module project. The main improvements are the addition of comprehensive guides for code quality, technical details, testing scripts, and the release process, as well as a GitHub Actions workflow to automate releases with semantic versioning.

Refined memory layout for stack and other sections too.

Documentation improvements:

  • Added docs/CODE_QUALITY.md with detailed instructions for static analysis, code formatting, and pre-commit hooks, including tool descriptions and usage examples.
  • Added docs/TECHNICAL.md providing in-depth technical details about the kernel module and user program, including memory region extraction, limitations, APIs used, and output format.
  • Added docs/SCRIPTS.md documenting all testing and utility scripts, including QEMU setup, usage, troubleshooting, and benefits of isolated kernel testing.
  • Added docs/RELEASE.md describing the automated release process, semantic versioning guidelines, and troubleshooting steps for releases.

Release automation:

  • Added .github/workflows/release.yml to automate version bumping, changelog updates, git tagging, and GitHub releases, triggered by PR labels or manual workflow dispatch.

@navidpadid navidpadid merged commit 9052456 into main Jan 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants