unikraft / docs

The front page and documentation for the Unikraft Open-Source Project.
https://unikraft.org
Other
33 stars 84 forks source link

Add documentation for running the checkpatch #180

Closed RaduNichita closed 1 year ago

RaduNichita commented 1 year ago

When contributing to most of the Unikraft's repositories, there is a requirement to run the checkpatch before submitting the PRs. Moreover, a Github action is run in this scenario in order to detect potential coding style issues.

However, there is not specified in the documentation how to run the checkpatch script locally.

StefanJum commented 1 year ago

The checkpatch usage is documented here. We could add a little more content to it indeed.