Skip to content

Commit cf52a39

Browse files
Update
1 parent bd051a6 commit cf52a39

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

src/gettingstarted/contributing.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,27 +27,36 @@ The rationale is to ensure
2727
- Simplicity. Upstream main branch is reviewed and distributable.
2828
- Tidiness. `git status` is clean or contains approved plugin changes.
2929

30-
To **add new plugins** from scratch
3130

32-
1. Request the creation of a repository (in the [community chat](/gettingstarted/help/)).
33-
2. Fork the repository to your account.
34-
3. Work on on the fork.
35-
4. Send a pull request to the upstream repository.
36-
5. Go through the review process until approved.
31+
### Fixes and Features
3732

38-
To **work on existing plugins** start at step 2.
39-
Discuss your planned changes with the maintainer(s) of the plugin before.
33+
Before putting a lot of effort into a contribution, open an issue and discuss your planned changes.
34+
This is important, because there is a chance that your changes may be rejected.
35+
Contributing to existing plugins is straightforward.
4036

41-
For a plugin repository to be accepted it has to satisfy the following **requirements**:
37+
1. Fork the repository to your account.
38+
1. Work on on the fork.
39+
1. Send a pull request to the upstream repository.
40+
1. Go through the review process until approved.
41+
42+
43+
### New plugins
44+
45+
We highly appreciate new plugin additions, however to be shipped there should be a demand for its use case.
46+
If you want your plugin to be added to the official repositories,
47+
put it to the list of candidates in the [awesome-albert](https://github.com/albertlauncher/awesome-albert) repository and
48+
promote it in the [community chat](/gettingstarted/help/).
49+
Plugins without users/stars will not be added to the official repositories.
50+
Once your plugin has some stars, you can request its addition to the official repositories.
51+
52+
For a plugin to be accepted it has to satisfy the following **requirements**:
4253
- The project is **licensed under a permissive open source license** (e.g. MIT, Apache, BSD).
4354
- The project has an **active maintainer**.
4455
- The repository **content is essential** to the functionality of the plugin. Keep in mind that in future somebody else may want to maintain the plugin and for distribution the size of the repository should be minimal.
4556
- Icons are **vector graphics** or **128x128 raster images**.
4657

4758
Having a _concise_ `README.md` summarizing features, requirements, limitations, supported platforms and implementation details is recommended.
4859

49-
If you have questions join the [community chats](/gettingstarted help/) and ask for help.
50-
5160

5261
## Reviews
5362

0 commit comments

Comments
 (0)