github/multus-cni
1
0
Fork 1
mirror of https://github.com/k8snetworkplumbingwg/multus-cni.git synced 2025-06-28 16:46:52 +00:00
Code Issues Projects Releases Wiki Activity

Adds development docs note regarding issue policy

Browse Source
This commit is contained in:
dougbtv 2020-04-29 15:26:10 -04:00 committed by Tomofumi Hayashi
parent 92beb4bcdc
commit c8fc357f05
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/development.md
View File

@ -1,6 +1,18 @@
## Development Information ## 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 git clone https://github.com/intel/multus-cni.git
@ -8,7 +20,7 @@ cd multus-cni
./build ./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: 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 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 * Add `logging.Debugf()` at the begining of functions
* In case of error handling, use `logging.Errorf()` with given error info * In case of error handling, use `logging.Errorf()` with given error info