Contributing

Thank you for considering helping improve the seL4 documentation.

This page is about contributing to the documentation site. For contributing to other parts of the seL4 ecosystem, visit our main contributing page.

We believe that documentation is important for any project and appreciate any contributions that improves it. The sort of contributions that we are looking for are:

For reporting issues about a particular project, please use the relevant repository’s issue tracker or post on the Devel mailing list.

As a reminder, all contributors are expected to follow our Code of Conduct.

Your First Contribution

You have noticed something that is wrong with some documentation on the site. GitHub makes it pretty easy to edit Markdown files without having to leave the browser. By clicking edit on the relevant file, making your change and then submitting a pull request someone can then review you change and merge it which will result in the update appearing on the website.

More detailed changes can be achieved by checking out the repository and editing locally, followed by commiting and making a pull request manually. The README.md describes how to host the site locally so that you can see how your changes are presented.

Contributions that are most helpful to us at the moment are:

Submitting a contribution

Contributions can be submitted by pull requests at https://www.github.com/sel4proj/docs.

Please try and follow the git commit style guide: http://chris.beams.io/posts/git-commit/

Style

This repo contains sources in various formats. We will add style guides and tools for checking conformance to these style guides. If there isn’t a tool to check style conformance, then we won’t be too pedantic about if the style is being followed correctly. The general principle is to follow the same style used in the rest of the file or similar files.

See the README.md for instructions on running style checks.

Languages and styleguides that are used:

Code review process

Someone who is familiar with the source will review your changes. They may request changes or have questions.
If no more feedback is required, we will likely approve and then merge the PR.

Reporting an issue or feature enhancement

To report an issue, open an issue in the repository issue tracker. Issues can be reporting problems, or ideas for improvement.

And if relevant

Community

Most community discussions about seL4 occur on our Devel mailing list. We also have an IRC channel that can be used.