Skip to content

Commit

Permalink
- add some best-practices
Browse files Browse the repository at this point in the history
  • Loading branch information
zhi-ching committed Feb 22, 2024
1 parent ea64dae commit c594292
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

## Best practices

### SDK API version
Always use the latest SDK API version as it contains the up-to-date feature and security patches. Kindly note that all the SDK version is backward compatible.

### One custom step per jar
It is recommended that you bundle one custom step per JAR. This will simplify the process of updating or removing a single custom step. And it will also promote security by isolation. A problematic custom step can be easily detected and isolated without affecting after custom step.

### Keep custom step or parser jar size minimal
Package the custom step/parser jar as small as possible (ie 10MB).

### Fat jar
Bundle the custom step in a fat jar where all dependencies are bundled into a single jar. This allow custom step to use specific version of libraries without affecting other custom step. For more details, [read this](README.md#class-isolation).

Expand Down Expand Up @@ -59,6 +65,9 @@ public StepProcessor createProcessor(final StepProcessorBuilder processorBuilder
}
```

### Semantic version
Remember to change the semantic version in `createMetadata` method provided by SDK API and jar package version after making changes to your custom step, parser, or file generator.

## Limitation
### Both custom chooser and column chooser cannot be reset
Once the value for the custom chooser or column chooser is selected, it cannot be reset to its initial state anymore. For example, once hash tag is selected for the prefix custom chooser, prefix custom chooser cannot be reset to display "Select a value".
Expand Down

0 comments on commit c594292

Please sign in to comment.