Skip to content

Commit 4e3cea1

Browse files
1 parent 930ff5f commit 4e3cea1

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

assets/js/search-data.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
},"8": {
5858
"doc": "Contributing",
5959
"title": "Code",
60-
"content": "The place for official plugin repositories is the Albert launcher organization. Distributed native plugins are submodules in the Albert repository plugins directory. Python plugins in the Python repository plugins directory respectively. The main branch of a plugin repository represents the latest version that is or will be distributed with the application and therefore has to be protected. Contributions have to pass peer reviewing via pull request. As such contributors have to work on their own fork and send a PR. The rationale is to ensure . | Safety. For users and developers. | Simplicity. Upstream main branch is reviewed and distributable. | Tidiness. git status is clean or contains approved plugin changes. | . Fixes and Features . Before putting a lot of effort into a contribution, open an issue and discuss your planned changes. This is important, because there is a chance that your changes may be rejected. Contributing to existing plugins is straightforward. | Fork the repository. | Work on the fork. | Send a pull request. | Go through the review process. | . New plugins . We highly appreciate new plugin additions, however to be shipped there should be a demand for its use case. If you want your plugin to be added to the official repositories, put it to the list of candidates in the organization readme and promote it in the community chat. Once your plugin has some users, you can request its addition to the official repositories. For a plugin to be accepted it has to satisfy the following requirements: . | The project is licensed under a permissive open source license (e.g. MIT, Apache, BSD). | The project has an active maintainer. | 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. | Icons are vector graphics or 128x128 raster images. | . Having a concise README.md summarizing features, requirements, limitations, supported platforms and implementation details is recommended. ",
60+
"content": "The place for official plugin repositories is the Albert launcher organization. Distributed native plugins are submodules in the Albert repository plugins directory. Python plugins in the Python repository plugins directory respectively. The main branch of a plugin repository represents the latest version that is or will be distributed with the application and therefore has to be protected. Contributions have to pass peer reviewing via pull request. As such contributors have to work on their own fork and send a PR. The rationale is to ensure . | Safety. For users and developers. | Simplicity. Upstream main branch is reviewed and distributable. | Tidiness. git status is clean or contains approved plugin changes. | . Fixes and Features . Before putting a lot of effort into a contribution, open an issue and discuss your planned changes. This is important, because there is a chance that your changes may be rejected. Contributing to existing plugins is straightforward. | Fork the repository. | Work on the fork. | Send a pull request. | Go through the review process. | . New plugins . We highly appreciate new plugin additions, however to be shipped there should be a demand for its use case. If you want your plugin to be added to the official repositories, put it to the list of candidates in the organization readme and promote it in the community chat. Once your plugin has some users, you can request its addition to the official repositories. For a plugin to be accepted it has to satisfy the following requirements: . | The project is licensed under a permissive open source license (e.g. MIT, Apache, BSD). | The project has an active maintainer. | 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. | Icons are vector graphics or 128x128 raster images. | Git history has to be linear | Git commits have to be Conventional Commit Spec compliant (automated versioning and changelogs) | . Having a concise README.md summarizing features, requirements, limitations, supported platforms and implementation details is recommended. ",
6161
"url": "/gettingstarted/contributing/#code",
6262

6363
"relUrl": "/gettingstarted/contributing/#code"

0 commit comments

Comments
 (0)