labwc/CONTRIBUTING.md

51 lines
1.5 KiB
Markdown
Raw Normal View History

# Contributing
2021-12-03 22:44:06 +00:00
## How to Contribute
2021-12-03 22:44:06 +00:00
## Packaging
2022-05-20 22:15:38 +02:00
Some distributions carry labwc in their repositories or user repositories.
- @ptrcnull (Alpine)
- @narrat (Arch)
- @jbeich (FreeBSD)
- @adcdam (Slackware)
kindly maintain the packages in their respective distro.
Let's keep them informed of new releases and any changes that relate to packaging.
If you are maintaining a labwc package for another distro feel free to open an issue so we can add you to this list.
## 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
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
```
And please wrap the main commit message at max 74 characters, otherwise `git log` and similar look so weird.
## 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.
## Native Language Support
Translators can add their `MY_LOCALE.po` files to the `po` directory
based on `po/labwc.pot` and issue a pull request.
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
[checkpatch.pl]: https://github.com/johanmalm/checkpatch.pl