Skip to content

Remove superfluous go:check template task #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2021
Merged

Remove superfluous go:check template task #147

merged 1 commit into from
Aug 18, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 16, 2021

There is an established practice of providing the developer with convenience "umbrella" tasks which collect multiple
tasks of a given type of operation. This has a couple of benefits:

  • Provides an alternative to manually running multiple tasks
  • Provides a standardized interface to the project, independent from its unique underlying details

However, I have come to the conclusion that these benefits lessen as the number of such convenience tasks increases. At
the same time, the maintenance burden increases. In the end, my preference is to have only the "umbrella" convenience
tasks at the highest possible level, which seems to be:

  • "build" (build the application)
  • "check" (check for problems with the project)
  • "fix" (automatically fix problems with the project)

The decision about whether to add mid-level "umbrella" convenience tasks is up to the maintainer of each project, but I
don't feel that it's appropriate to provide one as a "template". This task is not used by anything in this repository.

There is an established practice of providing the developer with convenience "umbrella" tasks which collect multiple
tasks of a given type of operation. This has a couple of benefits:

- Provides an alternative to manually running multiple tasks
- Provides a standardized interface to the project, independent from its unique underlying details

However, I have come to the conclusion that these benefits lessen as the number of such convenience tasks increases. At
the same time, the maintenance burden increases. In the end, my preference is to have only the "umbrella" convenience
tasks at the highest possible level, which seems to be:

- "build" (build the application)
- "check" (check for problems with the project)
- "fix" (automatically fix problems with the project)

The decision about whether to add mid-level "umbrella" convenience tasks is up to the maintainer of each project, but I
don't feel that it's appropriate to provide one as a "template". This task is not used by anything in this repository.
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Aug 16, 2021
@per1234 per1234 requested a review from umbynos August 16, 2021 18:50
@per1234 per1234 merged commit c0631d8 into arduino:main Aug 18, 2021
@per1234 per1234 deleted the remove-go-check branch August 18, 2021 08:51
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants