Skip to content

Latest commit

 

History

History
30 lines (30 loc) · 2.54 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

30 lines (30 loc) · 2.54 KB
Raw

Checklist for review:

  • Process name is fine, uses normal casing and descriptive
    • If applicable, the process name follows the naming convention "{source/format} to {destination/format} - {object}"
  • Process description is fine, uses normal casing, dots and is descriptive
    • Element names use normal casing, no unneeded capital letters
  • Correct casing used for formats and terms, e.g. CSV, FTP, JSON, Avro
    • Element names do not contain dots
    • Comments / note element text are in good language and end with dots
  • Template parameters checked
    • Parameter follows the CamelCase naming convention, abbreviations included, e.g. ConnectionString, BaseUrl, ApiKey
    • Parameter descriptions are good and end with dots
    • Sensitive parameters are marked as secrets
  • "Turn off logging" switch is on for any task that has sensitive data as output, e.g. tokens in the header.
  • Process end points like error throws and return statements have titles (double-click) and reasonable information.
    • Results have good summaries, preferably with statistics of some sort like "processed X files"
    • Errors have some error info, usually from task (e.g. some ErrorMessage property contains additional error info)
    • Errors are pointed downwards from their respective source, e.g. an exclusive decision
  • Process is organised with groups (dashed boxes)
  • Straight lines are preferred where possible
  • Subprocesses are forbidden
  • Text mode is preferred over Expressions in expressions, e.g. instead of $"This is {#var.error}" use This is {{#var.error}}
  • Process metadata file is present and content is fine (version number and name)
  • Process export file is present (process.json)
  • Process description file is present (all sections filled in)
  • Process description has a SVG screenshot of the process
  • Template files are going to the correct folder
  • Markdown paragraphs are separated with two newlines, so there is a blank line inbetween two paragraphs
  • If some system is integrated using e.g. a HTTP task (meaning we do not use a native connector for the system), then the system should be mentioned in additional systems used in metadata.json
  • If the template is handling some sample JSON data - make sure that the sample data is included in the long description (just one-two elements is enough)
  • If the template is assuming that there is a database table ready for data insertion / updates - include the table structure in the long description as a CREATE TABLE scipt.