Skip to content

Commit af74717

Browse files
Applying review updates for readability
Co-authored-by: Matt Dodson <[email protected]>
1 parent fcf9221 commit af74717

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

src/data/markdown/docs/07 extensions/02 Explanations/extensions-registry.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,28 @@ excerpt: Reasons for the registry and what is required to be included.
44
hideFromSidebar: false
55
---
66

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+
711
Our desire is to provide the best developer experience when using k6.
812
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 wide array of potential use cases.
1014

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.
1317
While we cannot guarantee the quality of community-provided extensions, we _can_ aid the evaluation by requiring certain consistencies.
1418

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-
1819
## 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:
2021

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
2223
- 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
2324
- a non-restrictive OSS license _(Apache2 preferred)_
2425
- an `examples` folder with at least one example to show proper usage
2526
- at least one [versioned release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
2627

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.
2829

2930
<Blockquote mod="note" title="">
3031

@@ -37,13 +38,13 @@ Some extensions may be very specific, where others are more general.
3738
Multiple extensions may even be created for the same product with different levels of support based upon version.
3839
By adhering to typical naming conventions, your extension name can remove some doubts as to what is supported.
3940

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/).
4142
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`.
4445

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.
4748
Applying our conventions, we'd recommend naming this repository as `xk6-output-awesomelog-v2`.
4849

4950
<Blockquote mod="note" title="">
@@ -54,8 +55,8 @@ Our goal is to quickly understand the intent of the extension.
5455

5556
## Potential for De-listing
5657
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.
5859
Such contact may be in the form of GitHub issues or merge requests.
5960

6061
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

Comments
 (0)