Skip to content

Commit cb6fd7b

Browse files
authored
add CONTRIBUTING.md
1 parent d463f15 commit cb6fd7b

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
You can contribute by:
4+
- [Suggesting new features](https://github.com/Aylur/astal/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=)
5+
- [Reporting bugs](https://github.com/Aylur/astal/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=)
6+
- Improving docs with additional contexts and examples
7+
- Adding more example projects to [examples](https://github.com/Aylur/astal/tree/main/examples)
8+
- Adding new language support/binding. For these open a PR for discussions.
9+
- Adding new libraries e.g support for more wayland compositors
10+
- [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/).
11+
12+
## Adding new libraries
13+
14+
Write libraries preferably in Vala. Only choose C if some dependency is only available in C e.g wayland.
15+
16+
## Todo
17+
18+
Planned features, you could help with:
19+
- [niri ipc library](https://github.com/Aylur/astal/issues/8)
20+
- sway ipc library
21+
- greetd ipc library
22+
- core: http request library, abstraction over libsoup included (mostly to be used in gjs and lua)
23+
- core: notification sending, libnotify clone [#26](https://github.com/Aylur/astal/issues/26)
24+
- setting up [uncrustify](https://github.com/uncrustify/uncrustify) for Vala

0 commit comments

Comments
 (0)