Common Way of Referring to Tekton Resources #1938
Labels
kind/cleanup
Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/documentation
Categorizes issue or PR as related to documentation.
lifecycle/rotten
Denotes an issue or PR that has aged beyond stale and will be auto-closed.
This same issue is being discussed in the CLI, and I wanted to raise a similar issue here. Tekton resources should be referred to in a consistent way whenever used in a way that an end user will see:
An example is TaskRun in
reconciler/taskrun.go
:TaskRun
pipeline/pkg/reconciler/taskrun/taskrun.go
Line 98 in 84368ae
taskRun
pipeline/pkg/reconciler/taskrun/taskrun.go
Line 110 in 84368ae
taskrun
pipeline/pkg/reconciler/taskrun/taskrun.go
Line 115 in 84368ae
My personal preference would be for using one word (i.e. TaskRun as opposed to task run) and to also capitalize the resource like so: TaskRun, PipelineRun, PipelineResource.
This would also apply to single word resources like Task and Pipeline as far as capitalizing.
I think this should also apply to documentation surrounding Tekton as well.
Very open to other formats around this, but I do think there should be consistency across all projects with regard to this.
The text was updated successfully, but these errors were encountered: