Thank you for considering helping improve the seL4 documentation.
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:
- Bug reporting
- Stale or incorrect sections
- Missing documentation
- Ideas of how our documentation could be structured differently
- Grammar and spell fixes (Nitpicks)
- Missing documentation
- Usage examples
- Links to related external documentation
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:
- Identifying which pages contain stale documentation. Filing an issue in the issue tracker will let us know that something is broken or old.
- Identifying areas where there is missing documentation or it is confusing
- Fixing any syntax errors left over from our migration from the old http://wiki.sel4.systems site.
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/
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:
- Markdown: GitHub flavoured markdown, rendered by kramdown. Styleguide. We intend on eventually using tidy-markdown but the current codebase isn’t compliant yet.
- HTML: Should be only used for presentation related content. Try and use markdown when possible. Styleguide. We use tidy for detecting errors in the generated site.
- SASS: Our styling should be kept into the
assets/cssfolders. We don’t currently follow a style guide.
- Liquid templating language: We use liquid-linter to check for liquid errors.
- python: use
pylintif you want.
- Makefile: tabs not spaces.
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.
- What is the issue?
- Why is it a issue?
And if relevant
- What do you think a good fix or change may be?
- How the fix or change removes the issue?