diff options
| author | Aylur <[email protected]> | 2024-09-30 15:27:25 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-09-30 15:27:25 +0200 |
| commit | cb6fd7bc8b0d517c0abb79d9c7c17933fe80c51c (patch) | |
| tree | d3bdfecc03b85f2831d791a8eae5a3706da45c5e | |
| parent | d463f15201352f8fe884f6dd70bbad87fec23e9e (diff) | |
add CONTRIBUTING.md
| -rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..494bfbf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# 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 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/). + +## 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 +- greetd ipc library +- core: http request library, abstraction over libsoup included (mostly to be used in gjs and lua) +- core: notification sending, libnotify clone [#26](https://github.com/Aylur/astal/issues/26) +- setting up [uncrustify](https://github.com/uncrustify/uncrustify) for Vala |