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>
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>
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>
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>
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>
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>
* 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>
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>
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>
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>