-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Add a CI Job to check proper formatting while submitting a PR #43335
Comments
This issue is currently awaiting triage. SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the The Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/assign |
/language en |
Make sure to use Prow for the checks (not GitHub Actions, which as a project we avoid). |
Thanks for the heads up, I'll keep that in mind
|
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
Hi folks !! Is this issue currently in progress? I'm also interested in the implementation of CI. Here are some points I'm curious about:
Regards :) |
I think the simple first step would be to ensure:
I think this would be effective for all languages |
/remove-lifecycle stale |
Thanks for the insights @Okabe-Junya I think this is one of those issues where sig-testing can help us. I'll rekindle this by reaching out on their slack channel btw, rolling out a beta for specific languages sgtm. We can start by clearing linting checks |
Are we going to use a linting tool for text? Or create one? |
What would you suggest @Affan-7? |
I have had good luck with markdownlint-cli in past projects. The tricky part will be configuring it so it helps more than hinders contributions. The default ruleset is fairly struct on markdown adherence, even the rendered output is fine. Adding that to an existing set of files would likely highlight a LOT of issues. Some will be legitimate things to fix, while others would be trivial cleanup that would be less important. The cluster-api-provider-vmware maintains a containerized image of this that makes it very easy to perform checks: https://github.com/vmware-tanzu/community-edition/blob/main/hack/check/check-mdlint.sh#L16 |
I think too. I also think we should start with the minimal configuration (meaning, we should initially have a rule set that produces almost no false positives). How about starting with spell check and link verification, for example? |
/scripts contains several excellent scripts. Running these in CI would be an easier step than introducing new tools. (If we were to introduce a new linter, we would have to spend a lot of time discussing its rule set.) |
Kubernetes have a lot of formatting standards, you can refer style guide. Can we configure markdownlint-cli to implement things like linting for headings and titles and other similar things? |
This sgtm. k8s/test-infra has all the ci jobs atm. If this works out, We can turn this into an umbrella issue and integrate different style guide checks. |
Sounds good!! @Gauravpadam, What about i18n? Should we initially target only English, and if it works well, then introduce it in other languages based on the decision of each localization team? Meaning, I think what we need to do is to add a simple CI workflow file for English documentation to k/test-infra? |
@Okabe-Junya Like you've mentioned earlier, some checks are common for all types of files, writing a workflow for them should be a quick win For i18n specifically? alphabetical ordering checks is what we should aim for initially imo |
Looks good!! Could you let me know in this issue when you open a PR to k/test-infra? |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close not-planned |
@k8s-triage-robot: Closing this issue, marking it as "Not Planned". In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
This is a Feature Request
What would you like to be added
We should add a CI Job to the repository to ensure that our contributors are following the formatting rules while submitting their PRs
Why is this needed
The merge of #43279 defines manual wrapping for ease of review and localization. The CI feature will make sure the style guide is adapted in our future PRs
The text was updated successfully, but these errors were encountered: