From 46d33872470c9173a156b4a27c2971d50e19ee6a Mon Sep 17 00:00:00 2001 From: Joseph Richard Date: Tue, 10 Dec 2024 00:01:34 -0700 Subject: [PATCH] Submit contributing guide --- CONTRIBUTING.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1892e3c..c0a7c4d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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