From c8fc357f05f61a94c9e4ebb20a08156cfc5bfda6 Mon Sep 17 00:00:00 2001 From: dougbtv Date: Wed, 29 Apr 2020 15:26:10 -0400 Subject: [PATCH] Adds development docs note regarding issue policy --- doc/development.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/development.md b/doc/development.md index c1410d670..977ad3a80 100644 --- a/doc/development.md +++ b/doc/development.md @@ -1,6 +1,18 @@ ## Development Information -## How to build the multus-cni? +## How do I submit an issue? + +Use GitHub as normally, you'll be presented with an option to submit a issue or enhancement request. + +Issues are considered stale after 90 days. After which, the maintainers reserve the right to close an issue. + +Typically, we'll tag the submitter and ask for more information if necessary before closing. + +If an issue is closed that you don't feel is sufficiently resolved, please feel free to re-open the issue and provide any necessary information. + +## How do I build multus-cni? + +You can use the built in `./build` script! ``` git clone https://github.com/intel/multus-cni.git @@ -8,7 +20,7 @@ cd multus-cni ./build ``` -## How to run CI tests? +## How do I run CI tests? Multus has go unit tests (based on ginkgo framework).The following commands drive CI tests manually in your environment: @@ -16,9 +28,9 @@ Multus has go unit tests (based on ginkgo framework).The following commands driv sudo ./test.sh ``` -## Logging Best Practices +## What are the best practices for logging? -Following are multus logging best practices: +The following are the best practices for multus logging: * Add `logging.Debugf()` at the begining of functions * In case of error handling, use `logging.Errorf()` with given error info