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/data/markdown/docs/07 extensions/02 Explanations/extensions-registry.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,27 +4,28 @@ excerpt: Reasons for the registry and what is required to be included.
4
4
hideFromSidebar: false
5
5
---
6
6
7
+
Did you create an extension and want to share it with your fellow k6 users?
8
+
We'd love to spread word of this new feature adding to our [registry](/extensions/get-started/explore/) of available extensions.
9
+
However, before an extension is added to the registry, we must ensure that it meets our quality standards.
10
+
7
11
Our desire is to provide the best developer experience when using k6.
8
12
This extends to the extensions ecosystem as well.
9
-
The adaptability provided by k6 extensions opens a wide-array of potential use cases.
13
+
The adaptability provided by k6 extensions opens a widearray of potential use cases.
10
14
11
-
The need for a well-maintained, curated listing of extensions is a necessity.
12
-
Our pledge to the community will be to make our best attempt to ensure those projects listed meet certain standards.
15
+
To ensure quality, we need a well-maintained, curated listing of extensions.
16
+
Our pledge to the community is to make our best attempt to ensure the listed projects meet certain standards.
13
17
While we cannot guarantee the quality of community-provided extensions, we _can_ aid the evaluation by requiring certain consistencies.
14
18
15
-
Did you create an extension and want to share it with your fellow k6 users?
16
-
We'd love to spread word of this new feature adding to our [registry](/extensions/get-started/explore/) of available extensions.
17
-
18
19
## Registry Requirements
19
-
At a minimum, each source code repository should have the following:
20
+
At minimum, each source code repository must have the following:
20
21
21
-
- a README file containing project description, build and usage documentation, and version compatibilities
22
+
- a README file with a project description, build and usage documentation, and version compatibilities
22
23
- the `xk6` topic _(See the [GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics))_ for discoverability
23
24
- a non-restrictive OSS license _(Apache2 preferred)_
24
25
- an `examples` folder with at least one example to show proper usage
25
26
- at least one [versioned release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
26
27
27
-
In addition, extensions must successfully build with version(s) of k6 no older than one year and must specify the k6 versions it is compatible with.
28
+
In addition, extensions must successfully build with versions of k6 no older than one year. You must specify the k6 versions it is compatible with.
28
29
29
30
<Blockquotemod="note"title="">
30
31
@@ -37,13 +38,13 @@ Some extensions may be very specific, where others are more general.
37
38
Multiple extensions may even be created for the same product with different levels of support based upon version.
38
39
By adhering to typical naming conventions, your extension name can remove some doubts as to what is supported.
39
40
40
-
For any extension we recommend the `xk6-` prefix as well as an optional `output-` for [Output extensions](/extensions/get-started/create/output-extensions/).
41
+
For any extension, we recommend the `xk6-` prefix as well as an optional `output-` for [Output extensions](/extensions/get-started/create/output-extensions/).
41
42
Next, provide the product or protocol name; don't be cryptic.
42
-
Ensure the usage is explicit by only adopting well-known acronyms or abbreviations if necessary.
43
-
If your extension only supports a specific version of a product, incorporate the version into the name, for example `v2`.
43
+
Ensure the usage is explicit by adopting only well-known acronyms or abbreviations if necessary.
44
+
If your extension supports only a specific version of a product, incorporate the version into the name, for example `v2`.
44
45
45
-
As an example, suppose we've created an extension to output test metrics to the _AwesomeLog_ application strictly using the v2 API.
46
-
In our case, let's say the latest v3 API is not backward-compatible.
46
+
As an example, suppose an extension that outputs test metrics to the _AwesomeLog_ application, and it uses only the v2 API.
47
+
In this case, say the latest v3 API is not backward-compatible.
47
48
Applying our conventions, we'd recommend naming this repository as `xk6-output-awesomelog-v2`.
48
49
49
50
<Blockquotemod="note"title="">
@@ -54,8 +55,8 @@ Our goal is to quickly understand the intent of the extension.
54
55
55
56
## Potential for De-listing
56
57
Given our desire to provide the best developer experience when using k6, we reserve the right to de-list any extension we deem is no longer maintaining standards.
57
-
Before any action takes place, the extension maintainers will be contacted in attempt to rectify the project and thus avoid de-listing.
58
+
Before any action takes place, the extension maintainers will be contacted to be given a chance to rectify the project and thus avoid de-listing.
58
59
Such contact may be in the form of GitHub issues or merge requests.
59
60
60
61
Should any extension be de-listed, this does not constitute a permanent removal.
61
-
Any extension having been de-listed may be reinstated once the reasons for the initial removal have been remediated.
62
+
Any extension that has been de-listed may be reinstated once the reasons for the initial removal have been remediated.
0 commit comments