Skip to content
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.

Sign up for GitHub

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

Jump to bottom

New PR and commit guidelines #2752

Closed
wants to merge 1 commit into from
Closed

New PR and commit guidelines #2752

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ at [kubevirt/containerized-data-importer](https://github.com/kubevirt/containeri
For bigger changes, please create a tracker Issue, describing what you want to
do. Then either as the first commit in a Pull Request, or as an independent
Pull Request, provide an **informal** design proposal of your intended changes.
The location for such propoals is
The location for such proposals is
[/docs](docs/) in the CDI repository. Make sure that all your Pull Requests link back to the
relevant Issues.

Expand Down Expand Up @@ -76,11 +76,14 @@ Maintainers are:
### PR Checklist

Before your PR can be merged it must meet the following criteria:
* Informative PR Description alongside an overview of the changes and a high-level design in case of a new feature
* Commits split logically with a clear purpose.
* Commits title concise and clear while commit message informative stating the nature and purpose of the changes in the commit.
Comment on lines +79 to +81
Copy link
Collaborator

@arnongilboa arnongilboa Jun 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may add

  • Currently our merge policy is squashing all PR commits, so consider:
  1. Splitting to incremental small PRs instead of a full feature PR
  2. Interactive rebase (git rebase -i) before PR is getting merged, so it won’t look like a list of useless titles

* [README.md](README.md) has been updated if core functionality is affected.
* Complex features need standalone documentation in [doc/](doc/).
* Functionality must be fully tested. Unit test code coverage as reported by
[Goveralls](https://coveralls.io/github/kubevirt/containerized-data-importer?branch=main)
must not decrease unless justification is given (ie. you're adding generated
must not decrease unless justification is given (i.e you're adding generated
code).


Expand Down