[Devtools Week] Update contributing guide #39
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #39 +/- ##
==========================================
+ Coverage 70.49% 73.12% +2.63%
==========================================
Files 11 11
Lines 1566 1563 -3
==========================================
+ Hits 1104 1143 +39
+ Misses 395 351 -44
- Partials 67 69 +2 ☔ View full report in Codecov by Sentry. |
CONTRIBUTING.md
Outdated
| contribution. See the [DCO](DCO) file for details. | ||
| Owners of the repository will watch out for and review new PRs. | ||
|
|
||
| By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests). |
There was a problem hiding this comment.
| By default for each change in the PR, GitHub Actions and OpenShift CI will run checks against your changes (linting, unit testing, and integration tests). | |
| For each change in the PR, GitHub Actions and OpenShift CI will by default run checks against your changes (linting, unit testing, and integration tests). |
There was a problem hiding this comment.
@thepetk Does these checks run only by default or in all cases? Are there any scenarios where they don't run all the checks mentioned?
There was a problem hiding this comment.
@michael-valdron I've removed the openshift CI as is doesn't exist as a check and added the code coverage checks.
Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Co-authored-by: Michael Valdron <mvaldron@posteo.net> Signed-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: thepetk <thepetk@gmail.com>
thepetk
force-pushed
the
ft/update_contributing_guide
branch
from
604c04c
to
9f6ed9e
Compare
|
@michael-valdron I've addressed your suggestions :) thanks for the review |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: michael-valdron, thepetk The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What does this PR do?
This PR updates the
contributing.mdin order to be more consistent with the rest of thecontributing.mdfiles inside theDevfileorganization. The updated document follows thecontributing.mdfile of theregistry-supportrepo (here)Which issue(s) does this PR fix
fixes devfile/api#1351
PR acceptance criteria
Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.
How to test changes / Special notes to the reviewer