diff options
| author | allexanderbergmans <allexander.bergmans@student.elisa.be> | 2026-07-03 11:02:00 +0200 |
|---|---|---|
| committer | allexanderbergmans <allexander.bergmans@student.elisa.be> | 2026-07-03 11:02:00 +0200 |
| commit | 50638e8d2a7f5bbd6d0e5243a67efb601896267b (patch) | |
| tree | 25c5a2141ca02d345eaae0f7f709ae006b3ba615 | |
chore: initialize repository
| -rw-r--r-- | COMMIT.MD | 178 | ||||
| -rw-r--r-- | README.MD | 59 |
2 files changed, 237 insertions, 0 deletions
diff --git a/COMMIT.MD b/COMMIT.MD new file mode 100644 index 0000000..20d8f6c --- /dev/null +++ b/COMMIT.MD @@ -0,0 +1,178 @@ +# Commit Message Guide + +BSDOS follows the Conventional Commits specification. + +## Format + +``` +<type>(<scope>): <short description> +``` + +Examples: + +``` +feat(kernel): implement scheduler initialization +fix(vfs): resolve inode reference leak +docs(readme): update project goals +refactor(mm): simplify page allocator +test(libc): add string function tests +build(toolchain): update compiler flags +chore(ci): add formatting workflow +``` + +--- + +## Commit Types + +### feat + +A new feature. + +``` +feat(kernel): add process scheduler +feat(net): implement UDP sockets +``` + +### fix + +A bug fix. + +``` +fix(vm): prevent page table corruption +fix(fs): correct FAT directory parsing +``` + +### docs + +Documentation only. + +``` +docs(readme): add build instructions +docs(api): document syscall interface +``` + +### style + +Formatting changes only. + +``` +style(kernel): format scheduler source +``` + +### refactor + +Code improvements without changing behavior. + +``` +refactor(vfs): simplify path resolution +``` + +### perf + +Performance improvements. + +``` +perf(mm): optimize slab allocator lookup +``` + +### test + +Adding or improving tests. + +``` +test(kernel): add scheduler unit tests +``` + +### build + +Changes affecting the build system or dependencies. + +``` +build(toolchain): support Clang 19 +build(make): improve release target +``` + +### ci + +Continuous Integration changes. + +``` +ci(github): add build workflow +``` + +### chore + +Miscellaneous maintenance. + +``` +chore: update .gitignore +chore: bump version number +``` + +### revert + +Reverting a previous commit. + +``` +revert: feat(kernel): add scheduler initialization +``` + +--- + +## Common Scopes + +``` +kernel +boot +arch +x86 +amd64 +arm64 +mm +vm +vfs +fs +net +ipc +proc +sched +drivers +pci +usb +acpi +libc +userland +shell +build +toolchain +docs +tests +ci +``` + +--- + +## Rules + +- Use the imperative mood. +- Keep the subject under ~72 characters. +- Do not end the subject with a period. +- Make one logical change per commit. +- Reference issues in the commit body when applicable. + +Good: + +``` +feat(kernel): add round-robin scheduler +fix(vfs): prevent null pointer dereference +docs(readme): document coding standards +``` + +Bad: + +``` +fixed stuff +update +changes +misc fixes +```
\ No newline at end of file diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..a5742a3 --- /dev/null +++ b/README.MD @@ -0,0 +1,59 @@ +# BSDOS + +A complete FreeBSD reimplementation, engineered from scratch. + +- Some components may be ported where appropriate. +- The majority of the codebase is custom-written. +- The long-term objective is compatibility without codebase dependency. + +## Project Goals + +- Build a modern BSD operating system from first principles. +- Maintain compatibility with the FreeBSD ecosystem where practical. +- Produce clean, well-documented, maintainable code. +- Prioritize correctness, performance, and security. + +## Current Status + +- Project started: 02 July 2026. +- Architecture and design phase. +- No stable releases yet. +- Name is temporary. + +## Scope + +The project intends to implement: + +- Kernel +- Device drivers +- Virtual memory subsystem +- Process scheduler +- Filesystems +- Networking stack +- Userland utilities +- Build system +- Package management (planned) + +## Design Principles + +- Simplicity over unnecessary complexity. +- Readable and maintainable source code. +- Minimal external dependencies. +- Standards compliance whenever possible. +- Security by design. + +## Licensing + +License: TBD. + +## Contributing + +Contributions are currently closed while the core architecture is being established. + +## Maintainer + +Maintained by: + +Allexander B. <al@fyntoraos.com> + +Project owner and lead developer.
\ No newline at end of file |
