summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 8b4ea71d7f7a8cb3cca7b6c4d25918d7326773d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Contributing

You can contribute by:

- [Suggesting new features](https://github.com/Aylur/astal/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=)
- [Reporting bugs](https://github.com/Aylur/astal/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=)
- Improving docs with additional contexts and examples
  - adding more distros to sections about installations e.g [building from source](https://aylur.github.io/astal/guide/getting-started/installation#building-from-source)
- Adding more example projects to [examples](https://github.com/Aylur/astal/tree/main/examples)
- Adding new language support/binding. For these open a PR for discussions.
- Adding new libraries e.g support for more wayland compositors
- [Adding](https://github.com/Aylur/astal/tree/main/docs#add-your-creation-to-the-showcases-page) your project to the [showcases page](https://aylur.github.io/astal/showcases/).
- Creating packaging for distributions

## Adding new libraries

Write libraries preferably in Vala. Only choose C if some dependency is only available in C e.g wayland.

## Todo

Planned features, you could help with:

- [niri ipc library](https://github.com/Aylur/astal/issues/8)
- sway ipc library
- http request library abstraction over libsoup (mostly to be used in gjs and lua)
- notification sending libnotify clone [#26](https://github.com/Aylur/astal/issues/26)
- setting up [uncrustify](https://github.com/uncrustify/uncrustify) for Vala
- bluetooth custom errordomains, currently every error is simply Error