Skip to content

Commit 22e3800

Browse files
docs(*): add contributor guidelines
1 parent 5d67f57 commit 22e3800

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,49 @@ Remove this section if this change applies to all flows or to the documentation
3535
If there are no setup requirements, you can remove this section.
3636
3737
Thank you for your contribution. ❤️ -->
38+
39+
---
40+
41+
### Contributor Checklist ✅
42+
43+
- [ ] PR Title and commits follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
44+
- [ ] Add a `closes #ISSUE_ID` or `fixes #ISSUE_ID` in the description if the PR relates to an opened issue.
45+
- [ ] Documentation updated (plugin docs from `@Schema` for properties and outputs, `@Plugin` with examples, `README.md` file with basic knowledge and specifics).
46+
- [ ] Setup instructions included if needed (API keys, accounts, etc.).
47+
- [ ] Prefix all rendered properties by `r` not `rendered` (eg: `rHost`).
48+
- [ ] Use `runContext.logger()` to log enough important infos where it's needed and with the best level (DEBUG, INFO, WARN or ERROR).
49+
50+
⚙️ **Properties**
51+
- [ ] Properties are declared with `Property<T>` carrier type, do **not** use `@PluginProperty`.
52+
- [ ] Mandatory properties must be annotated with `@NotNull` and checked during the rendering.
53+
- [ ] You can model a JSON thanks to a simple `Property<Map<String, Object>>`.
54+
55+
🌐 **HTTP**
56+
- [ ] Must use Kestra’s internal HTTP client from `io.kestra.core.http.client`
57+
58+
📦 **JSON**
59+
- [ ] If you are serializing response from an external API, you may have to add a `@JsonIgnoreProperties(ignoreUnknown = true)` at the mapped class level. So that we will avoid to crash the plugin if the provider add a new field suddenly.
60+
- [ ] Must use Jackson mappers provided by core (`io.kestra.core.serializers`)
61+
62+
**New plugins / subplugins**
63+
- [ ] Make sure your new plugin is configured like mentioned [here](https://kestra.io/docs/plugin-developer-guide/gradle#mandatory-configuration).
64+
- [ ] Add a `package-info.java` under each sub package respecting [this format](https://github.com/kestra-io/plugin-odoo/blob/main/src/main/java/io/kestra/plugin/odoo/package-info.java) and choosing the right category.
65+
- [ ] Icons added in `src/main/resources/icons` in SVG format and not in thumbnail (keep it big):
66+
- `plugin-icon.svg`
67+
- One icon per package, e.g. `io.kestra.plugin.aws.svg`
68+
- For subpackages, e.g. `io.kestra.plugin.aws.s3`, add `io.kestra.plugin.aws.s3.svg`
69+
See example [here](https://github.com/kestra-io/plugin-elasticsearch/blob/master/src/main/java/io/kestra/plugin/elasticsearch/Search.java#L76).
70+
- [ ] Use `"{{ secret('YOUR_SECRET') }}"` in the examples for sensible infos such as an API KEY.
71+
- [ ] If you are fetching data (one, many or too many), you must add a `Property<FetchType> fetchType` to be able to use `FETCH_ONE`, `FETCH` and even `STORE` to store big amount of data in the internal storage.
72+
- [ ] Align the `"""` to close examples blocks with the flow id.
73+
74+
🧪 **Tests**
75+
- [ ] Unit Tests added or updated to cover the change (using the `RunContext` to actually run tasks).
76+
- [ ] Add sanity checks if possible with a YAML flow inside `src/test/resources/flows`.
77+
- [ ] Avoid disabling tests for CI. Instead, configure a local environment whenever it's possible with `.github/setup-unit.sh` (which can be executed locally and in the CI) all along with a new `docker-compose-ci.yml` file (do **not** edit the existing `docker-compose.yml`).
78+
- [ ] Provide screenshots from your QA / tests locally in the PR description. The goal here is to use the JAR of the plugin and directly test it locally in Kestra UI to ensure it integrates well.
79+
80+
📤 **Outputs**
81+
- [ ] Do not send back as outputs the same infos you already have in your properties.
82+
- [ ] If you do not have any output use `VoidOutput`.
83+
- [ ] Do not output twice the same infos (eg: a status code, an error code saying the same thing...).

0 commit comments

Comments
 (0)