open_kernel/CONTRIBUTING.md

Contributing to Open Agila

Start with a small change you can explain and test. A University certificate records completed checks; a contribution also needs working source and evidence.

Your first patch

1. Clone this repository, record git rev-parse HEAD, and run make test on the supported build environment.
2. Choose one issue with a bounded acceptance test. Read the relevant implementation and its public contract before editing.
3. Create a branch: git switch -c my-port-test.
4. Make one focused change. For a bug fix, demonstrate the failure before the fix and success afterward.
5. Run the relevant tests; include make boot-test when changing shared port or boot code. Never run a development kernel on the production Forge or University machine itself.
6. Review git diff. Commit source and documentation, not binaries, build output, credentials, or private Agila code.
7. Push to your own repository or authorized branch and open a pull request with the problem, behavior, commands, results, and limitations.

Public reading and cloning do not need an account. Authenticated contributions currently require a Forge account provisioned by the project owner. Lesson progression and certificates do not depend on receiving a human review.

Patch evidence template

• Requirement and affected files:
• Before/after behavior:
• Exact source revision, toolchain version, and target:
• Reproduction/test commands:
• Observed results, including one failure or boundary case:
• Remaining limitations:
• AI assistance used and what you independently checked:

AI can help draft code or tests, but the contributor must understand the patch, verify referenced APIs, test its behavior, and explain its assumptions. Do not claim tests were run on hardware you did not use.

Tagalog: Unawain ang kontrata at source. Gumawa ng maliit na pagbabago at test na may malinaw na inaasahang resulta. Itala ang aktuwal na resulta at limitasyon. Huwag maglagay ng password o pribadong code sa commit.

Bisaya: Sabta ang kontrata ug source. Paghimo og gamay nga kausaban ug test nga adunay klarong gipaabot nga resulta. Itala ang aktuwal nga resulta ug limitasyon. Ayaw pag-apil og password o pribadong code sa commit.