Ask contributors without write access to keep no more than three pull requests
open at the same time, so that maintainer review — the project's limiting
resource — is not spread too thin, enforced through the repository's pull
request limit. Contributors with write access, who are actively engaged with
the project, are not restricted; anyone with a genuine need to exceed the limit
can raise it with a maintainer.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit 83b2c2e488)
The development flow guide described running unit tests and `make lint`, but
several other checks also gate every pull request and were documented nowhere:
`make golangci-lint`, `make codegen`, `make crds`, and commitlint. A contributor
had no way to learn about them short of pushing and reading a red CI run.
Add a table of the gating checks and the command that runs each one locally,
and document the parts that are easy to get wrong:
- Any change under `pkg/apis` requires regenerating the client, deepcopy
functions, CRD manifests, and CRD reference docs, and the regenerated files
belong in the same commit. This includes editing a godoc comment, since those
comments are copied verbatim into the CRD description fields.
- Commitlint infers a trailer from the shape of a line, so a body line that
begins with a word followed by a colon is read as one, and the commit is
rejected with `footer-leading-blank`.
- The commit prefix must come from the type list in `.commitlintrc.json`.
Also note that `make test` only covers `cmd/` and `pkg/`, so test files under
`tests/framework/` are compiled but never run by the unit test CI.
Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit e32ea6cbab)
Add AI guidelines based on discussions from the most recent community
meeting.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
(cherry picked from commit ebf4656481)
the markdownlint and markdownlint.fix make targets
required markdownlint-cli2 to be installed locally
in the $PATH.
This change renders them self-contained by running
markdownlint from the official markdownlint-cli2
docker image.
Also clean the development-flow guide for linting tools
Signed-off-by: Michael Adam <obnox@samba.org>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Travis Nielsen <tnielsen@redhat.com>
The development guide mentioned that commit messages
should be lengthy which has a negative connotation
of meaning long-winded.
This change rewords the corresponding part to sound more positive.
Signed-off-by: Michael Adam <obnox@samba.org>
This change expands the section about regression testing in the
developer guide by adding information about how to run linters
locally.
Signed-off-by: Michael Adam <obnox@samba.org>
mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.
As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.
markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:
- all doc lines (except code blocks) must be aligned to a 4-space
boundary, without exception. This ensures that markdown will render
correctly with mkdocs. This unfortunately makes it possible to create
lists that are internally aligned strangely.
- admonitions must all follow the same format of
```
!!! header
body
```
For the strange lists, this is allowed and renders correctly, but it
looks strange:
```md
- first bullet
- second bullet
still second bullet
- third bullet
has a paragraph
of text inside
- last bullet
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
we don't want to wait for extra 10min once the ci passed,
so we'll add a check if `debug-ci` label is added or debug runner
is triggered from UI then only start tmate. Also, updaing the
development doc and rook test doc.
Signed-off-by: subhamkrai <srai@redhat.com>
The unit tests are not necessary if a PR is being opened for
documentation or other non-code changes, so we clarify the
instructions.
Signed-off-by: travisn <tnielsen@redhat.com>
The dev guide had some outdated info that is now updated,
as well as some rewording for consistency and improved
writing.
Signed-off-by: travisn <tnielsen@redhat.com>
Adding instructions to fetch the tags as they are used during
the build process. The current instructions only require the
user to clone the project which results in build errors later
on.
Closes: https://github.com/rook/rook/issues/11619
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
The Note label is updated in several places in the docs for improved rendering.
Multiple markdown files have been updated.
Closes: #10458
Signed-off-by: Yashasvi Chaurasia <yashasvi12977@gmail.com>
In linux environment, when go is installed using
`dnf/yum/apt` or other pacakge installer. In this case we
get error when we do `make build` because of GOPROXY.
So, we need to update the GOPROXY with `export GOPROXY=https://proxy.golang.org,direct`
in `.bashrc` file
Signed-off-by: subhamkrai <srai@redhat.com>
This adds vscode json files to recommend extensions and set some
settings which are used to make the development easier.
Signed-off-by: Alexander Trost <galexrt@googlemail.com>