2022-03-28 21:39:15 +01:00
|
|
|
# Contributing
|
2021-12-03 22:44:06 +00:00
|
|
|
|
2022-03-28 21:39:15 +01:00
|
|
|
## How to Contribute
|
2021-12-03 22:44:06 +00:00
|
|
|
|
2022-03-28 21:39:15 +01:00
|
|
|
## Packaging
|
|
|
|
|
|
|
|
|
|
@narrat and @jbeich kindly maintain package on Arch Linux and FreeBSD. Let's
|
|
|
|
|
keep them informed of any changes that relate to packaging.
|
|
|
|
|
|
|
|
|
|
## Coding Style
|
|
|
|
|
|
|
|
|
|
Let's try to stick to sircmpwn's [coding style]. If you're not used to it, you
|
|
|
|
|
can use [checkpatch.pl] to run a few simple formatting checks.
|
|
|
|
|
|
|
|
|
|
## Commit Messages
|
2021-12-03 23:14:52 +00:00
|
|
|
|
2021-12-26 23:14:21 +00:00
|
|
|
Write [commit messages] like so, keeping the top line to this sort of syntax:
|
2021-12-03 22:44:06 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
cursor: add special feature
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-26 23:14:21 +00:00
|
|
|
And please wrap the main commit message at max 74 characters, otherwise `git log` and similar look so weird.
|
|
|
|
|
|
2022-03-28 21:35:59 +01:00
|
|
|
## Naming Convention
|
|
|
|
|
|
|
|
|
|
There are three types of coordinate systems: surface, output and layout - for
|
|
|
|
|
which the variables (sx, sy), (ox, oy) and (lx, ly) are used respectively in
|
|
|
|
|
line with wlroots.
|
|
|
|
|
With the introduction of the scene-graph API, some wlroots functions also use
|
|
|
|
|
node coordinates (nx, ny) but we prefer (sx, sy) where possible.
|
|
|
|
|
|
|
|
|
|
|
2021-12-03 22:44:06 +00:00
|
|
|
[coding style]: https://git.sr.ht/~sircmpwn/cstyle
|
|
|
|
|
[commit messages]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/CONTRIBUTING.md#commit-messages
|
2021-12-03 23:14:52 +00:00
|
|
|
[checkpatch.pl]: https://github.com/johanmalm/checkpatch.pl
|
|
|
|
|
|
