Getting help and contributing

Where to ask a question, report a bug or a vulnerability, and how to propose a change to NoWayOS.

NoWayOS is developed in the open under the NoWayOS organisation on GitHub. That is where to find the code, ask about it and change it.

The repositories are being prepared for publication. Until they are public, what follows needs access to the NoWayOS organisation.

Questions and bugs

Open an issue in the repository concerned: nowayos for the operating system, screen-compiler for converting screens, showcase for the example kiosks. A good issue says what you ran, what you expected and what happened instead, with the output, and the commit you ran it on.

Before you do, DEVELOPING.md in each repository covers building, testing and the layout of the code, and the glossary explains the terms.

Security vulnerabilities

Please do not open a public issue for a vulnerability. Report it privately, as the SECURITY.md file in each repository describes. The report stays private until a fix is available.

Proposing a change

Read the repository's DEVELOPING.md, and its ground rules in particular: they are enforced by the gate, so a change that breaks one will not pass.
Make the change, with tests. For a bug, write the failing test first.
Run make ci and see it pass.
Open a pull request saying what the change does and why. If it widens what a system grants, say so: a wider grant is reviewed as a security change.

Contribution guidelines will be published with each repository.

The words

NoWayOS uses a few words in specific senses: protection domain, grant, expect file, fail-safe state and others. The glossary defines each one.