-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3c89e0a
commit 46d3387
Showing
1 changed file
with
35 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,35 @@ | ||
| CONTRIBUTING.md | ||
| # Tracking | ||
| ## Bugs | ||
| Bugs should all be tracked through github issues in the ptp-operator repo. Issues should not be raised in the linuxptp-daemon repo, except where for repo-specific things (e.g. issues with image builds in the repo). This is in order to allow all project bugs to be tracked together | ||
| ## Features | ||
| Features should be tracked through github issues in the ptp-operator repo. | ||
|
|
||
| # Submissions | ||
| ## Submission expectations: | ||
| Contributors are responsible for ensuring the following with their submissions: | ||
| - Contributors are responsible for only adding code that they wrote, or is licensed appropriately. No GPL code should be imported. | ||
| - Code is tested adequately | ||
| - See https://github.com/k8snetworkplumbingwg/ptp-operator/blob/master/TESTING.md for more details on expectations of testing prior to submission | ||
| - Code introduces sufficient new test coverage | ||
| - See https://github.com/k8snetworkplumbingwg/ptp-operator/blob/master/TESTING.md for more details on expectations of added test coverage | ||
| - We expect that each tracked issue (feature or bug) will be a single complete submission per repo(daemon and operator), rather than several partial/incomplete submissions, unless not possible for technical reasons | ||
| - all tracking under ptp-operator repo | ||
| - Commit messages will adequately describe what’s being done | ||
| - Title: summarize the code change | ||
| - Title: include the bug ticket #, but not a copy of bug title (bug title can be included in the description) | ||
| - Description: explain the Root Cause and Solution | ||
| - PR is linked to a github issue under the ptp-operator repo | ||
| - PR will follow best practices, be well written, and adequately commented. | ||
| ## Review expectations | ||
| Maintainers are responsible for ensuring that adequate review is conducted. This includes the following: | ||
| - PR is aligned with the design plan of the project | ||
| - Issues should be rejected if going against maintainer design intent | ||
| - PR adequately addresses the issue it’s intended to fix | ||
| - PR code follows best practices | ||
| - PR does not break anything | ||
| - PR does not introduce any security issues | ||
| - PR does not introduce any potential performance issues | ||
| Testing by submitter is adequate | ||
| - PR adds necessary test coverage | ||
| - PR commit message is descriptive of what’s being done | ||
| - PR is not introducing proprietary code, except in plugin section |