You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/gettingstarted/contributing.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,16 @@ nav_order: 3
10
10
- TOC
11
11
{:toc}
12
12
13
+
13
14
## Promotion
14
15
15
16
-[Star Albert on GitHub](https://github.com/albertlauncher/albert).
16
17
-[Star your favorite plugins](https://github.com/orgs/albertlauncher/repositories). Also helps triaging issues.
17
18
- Spread the word on social media.
18
-
- Vote on rankings like [alternative.to](https://alternativeto.net/software/albert/about/), [slant](https://www.slant.co/topics/3945/~app-launchers-for-unix-like-systems) and such.
19
+
- Vote on rankings like [alternative.to](https://alternativeto.net/software/albert/about/) and such.
20
+
19
21
20
-
## Code
22
+
## Code
21
23
22
24
The **place for official plugin repositories** is the [Albert launcher organization](https://github.com/orgs/albertlauncher/repositories).
23
25
Distributed native plugins are submodules in the [Albert repository plugins directory](https://github.com/albertlauncher/albert/tree/main/plugins).
@@ -54,46 +56,50 @@ Having a _concise_ `README.md` summarizing features, requirements, limitations,
54
56
55
57
If you have questions join the [community chats](/gettingstarted help/) and ask for help.
56
58
59
+
57
60
## Reviews
58
61
59
-
Your efforts helps plugins being shipped _faster_.
60
62
You can review [current pull requests](https://github.com/issues/assigned?q=is%3Apr%20state%3Aopen%20org%3Aalbertlauncher) directly any time.
61
63
You can also join the [reviewer teams](https://github.com/orgs/albertlauncher/teams).
62
64
These teams will be assigned on new pull requests and as such you will get a notification.
63
65
Leave a message with your GitHub username to get an invite.
64
66
67
+
65
68
## Maintenance
66
69
67
-
If you are using a plugin a lot and have C++ or Python skills you are probably a good plugin maintainer.
68
-
Send a PR adding your GitHub username to the maintainers array of the plugin metadata and you're in.
69
-
Revert it to step back.
70
-
If you are a maintainer you will be assigned on new issues and pull requests.
70
+
If you are using a plugin a lot and have basic programming skills you are probably a good plugin maintainer.
71
+
As passive maintainer you can help by using the plugin, reporting issues and sending pull requests containing fixes and features.
72
+
As an active/official maintainer you will be assigned on new issues and pull requests (for reviews).
73
+
To opt-in as active maintainer send a pull request adding your GitHub username to the maintainers array of the plugin metadata.
74
+
Revert to opt-out.
71
75
72
-
<!--
73
-
## Changes to the core application
76
+
77
+
<!--## Changes to the core application
74
78
75
79
Currently the core app is source available and proprietary.
76
80
Changes have to be well thought out, since they often have unwanted side effects.
77
81
Lots of additions had to be reverted in the past.
78
82
I learned my lessons and will not merge contributions carelessly.
79
83
Probably you will not have fun matching my standards of defensive code.
80
84
If you still want to work on the core, be sure to get in touch with me _before_ starting.
81
-
-->
85
+
82
86
83
87
## Translations
84
88
85
89
Albert and the native plugins are fully internationalized.
86
90
Unfortunately there is no streamlined localization flow yet.
87
91
Currently the translations go directly into the (sub)projects.
88
92
So you have to commit to each plugin separately.
89
-
Future plan is to have a separate repository for the translations.
93
+
Future plan is to have a separate repository for the translations.-->
94
+
90
95
91
96
## Documentation
92
97
93
98
Each page on the website contains an _'Edit this page on GitHub'_ link in the footer that you can use to send improvements.
94
99
The API reference is generated from source code, in particular the header files of the public API.
95
100
To improve the API reference, send a pull request with the changes to the header files in the `include` directory in the [Albert repository](https://github.com/albertlauncher/albert/tree/main/include/albert).
96
101
102
+
97
103
## Appreciation
98
104
99
-
Support me as a creator by [becoming a sponsor or donating](/donation/) some bucks.
105
+
Support @manuelschneider as a creator by [becoming a sponsor or donating](/donation/).
0 commit comments