Commit Graph
20 Commits
Author SHA1 Message Date
Satoru Takeuchi b585c35743 docs: mark overwriting Ceph's configurations as breaking change
Mark overwriting Ceph's configurations as breaking changes.
This is to avoid troubles caused by such changes on upgrade.

ref.
https://github.com/rook/rook/discussions/16652

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2025-11-12 22:29:24 +00:00
parth-gr 7ddc0a23fb doc: a try to change the PR template better
Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-01-11 19:57:52 +05:30
travisn cc2e8e6e60 build: clarify pr instructions
Since nobody seems to see the instructions for opening a PR,
make another attempt to clarify what someone should do
when they are opening a PR.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-11-06 22:44:41 -06:00
travisn a273a0be1b docs: remove skip-ci from pr checklist
The skip-ci label can only be added to the PRs by members of the org,
and also the label is not necessary for changes that are only
to the documentation folder.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-09-08 14:17:36 -06:00
travisn e1190d7e6c docs: fix typo in the pr template
The pr template has an extra parenthesis that is now
removed. Also make the development guide easier to
notice since the comment does not show a proper
markdown link.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-05-01 09:07:30 -06:00
subhamkrai 49a35a9311 docs: update doc path according to new doc change
we need to update the referred doc path
according to our latest doc change.

Signed-off-by: subhamkrai <srai@redhat.com>
2022-06-01 20:17:44 +05:30
Travis Nielsen 9003f1b2fc docs: update the pr template checklist
The PR checklist has a couple links that were outdated
and some other items that are generally not necessary to
consider in every PR. Now the checklist is more concise
and links are updated.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-03-02 12:00:07 -07:00
Travis Nielsen 0591753673 docs: update master doc links to latest
With the renaming of master docs to latest, all the links also
need to be updated.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2021-09-22 12:41:32 -06:00
Sébastien Han d680b00ad7 bot: change PR template
Reflect the change from commitlint bot to commitlint action check.

Signed-off-by: Sébastien Han <seb@redhat.com>
2020-05-28 17:36:04 +02:00
Travis Nielsen c7310ec802 git: clarify CI flags in PR template
The commitlint bot is rarely understood and flags to skip the CI are
rarely used by new contributors. This update to the PR template
aims to make these options more discoverable to newer members of
the community

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2020-04-09 00:11:16 -06:00
travisn 807326049e fix the links in the PR checklist
The relative links in the PR template are broken so we
need to specify full paths.

Signed-off-by: travisn <tnielsen@redhat.com>
2019-07-17 23:29:52 -06:00
Sébastien Han 35d6f73d5e Merge pull request #3432 from leseb/checklist-pr
PR checklist and Issue template update
2019-07-12 12:06:25 +02:00
travisn 9af20e8dc0 Add documentation for skipping the CI
The CI only needs to be run for PRs that have code changes.
PRs that are only documentation, yaml, or other files
that are not built should skip the long and tedious
CI process. This makes the [skip ci] flag more discoverable.

Signed-off-by: travisn <tnielsen@redhat.com>
2019-07-11 16:40:40 -06:00
Sébastien Han 142b2caa00 pr: add more items to the checklist
* when submitting code people must be provide unit tests
* when submitting code for a new functionnality, integration tests must
be added so we can get coverage of that feature in the CI.

Signed-off-by: Sébastien Han <seb@redhat.com>
2019-07-11 15:37:05 +02:00
Steven Rathbauer fb60206114 Correcting broken/wrong links in templates
Fixes ##3046

Signed-off-by: Steven Rathbauer <steven@rathpc.com>
2019-04-25 10:02:21 -07:00
Bassam Tabbara 2464e32857 add vendor checks
this commit updates dep to version 0.5, and adds a check during
CI runs that enforces that the vendor dependencies have not changed.
There is a now a makefile target `make vendor.check` that performs
this check. Also removed the requirement that PR run make vendor as
this will be done by CI.

Signed-off-by: Bassam Tabbara <bassam@upbound.io>
2018-09-30 08:10:42 -07:00
Blaine Gardner 4fdbdeb542 PR template: Add godoc comments to checklist
We want to have good code documentation in the future, and we would like
to slowly develop better documentation for existing code. As a checklist
item for PRs, add a requirement for godoc-style comments when (1) new
code items are added and (2) when existing items are sufficiently
modified.

Signed-off-by: Blaine Gardner <blaine.gardner@suse.com>
2018-08-14 14:03:22 -06:00
Alexander Trost e253b6ada5 github: Separated bug and feature issue templates
This makes use of GitHub's feature to give a selection on issue creation
this splits the issue types in bug report and feature request.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2018-06-25 21:57:58 +02:00
travisn a0341f528e upgrade should be tested and documented if necessary
Signed-off-by: travisn <tnielsen@redhat.com>
2018-06-01 15:18:26 -07:00
Alexander Trost c567bb24ed Added GitHub pull request template 2018-01-02 23:23:10 +01:00