Skip to content
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

[docs] Reduce amount of make targets required for a PR #36226

Open
hughesjj opened this issue Nov 6, 2024 · 1 comment · May be fixed by #36342
Open

[docs] Reduce amount of make targets required for a PR #36226

hughesjj opened this issue Nov 6, 2024 · 1 comment · May be fixed by #36342

Comments

@hughesjj
Copy link
Contributor

hughesjj commented Nov 6, 2024

Component(s)

No response

Describe the issue you're reporting

Can we make a new "alias" makefile target to reduce the number of make command needed to run before submitting a PR, as specified in contributing.md?

Currently, it's

  * Before submitting a PR, run the following commands from the root of the repository to ensure your new compone
nt is meeting the repo linting expectations:
    * `make checkdoc`
    * `make checkmetadata`
    * `make checkapi`
    * `make goporto`
    * `make crosslink`
    * `make gotidy`
    * `make genotelcontribcol`
    * `make genoteltestbedcol`
    * `make generate`
    * `make multimod-verify`
    * `make generate-gh-issue-templates`
    * `make addlicense`

but I'd rather have

.PHONY: prep-pr
prep-pr: checkdoc checkmetadata checkapi goporto crosslink gotidy genotelcontribcol genoteltestbedcol generatemultimod-verify generate-gh-issue-templates addlicense

Alternatively, we could make PR requirements a precommit hook, but that would require contributors setting up precommit. Given the "heft" of these commands, it'd probably better to specifically use a pre-push hook

As an aside, it'd be nice to have a docs label or similar for issues like this.

@hughesjj hughesjj added the needs triage New item requiring triage label Nov 6, 2024
@atoulme
Copy link
Contributor

atoulme commented Nov 6, 2024

Sounds good, please feel free to offer a PR

@atoulme atoulme added Contribfest and removed needs triage New item requiring triage labels Nov 9, 2024
@hughesjj hughesjj linked a pull request Nov 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants