Contributing to QTIP
First of all, thanks for taking your time to contribute.
QTIP is a project in OPNFV. If you are new to OPNFV, you may read Developer Getting Started first.
Peer review is the most important communication channel between developers. Every subtle change to the code or document MUST be reviewed before submission.
qtip-reviewers in gerrit when you consider a patch set is ready.
Rule for Submit
Only members in
ldap/opnfv-gerrit-qtip-submitters, i.e. committers have permission to submit. The current committers are listed in INFO.
Before submitting a patch set, please make sure one of the following criteria is met:
- Normal: at least one
- Fast Track: no objection from other committers for one or more working day
NOTE: we introduce fast track because currently there are not enough active committers reviewing the patch sets.
Current list of active reviewers in gerrit group
- Akhil Batra email@example.com
- Serena Feng firstname.lastname@example.org
- Taseer Ahmed email@example.com
- Yujun Zhang firstname.lastname@example.org
- Zhifeng Jiang email@example.com
- Zhihui Wu firstname.lastname@example.org
By becoming an active reviewer, you agree to allow others to invite you as reviewers in QTIP project freely. Any one in OPNFV community can apply to join QTIP reviewers group or leave by submitting a patch on this document.
Tasks and Issues
Task: it must be achievable in one sprint, otherwise it needs to be split.
Sub-Task: it must be resolvable by one developer within one sprint, otherwise it need to be split.
Epic are not restricted by time frame. But it is recommended to to define the scope clearly and break down into manageable tasks.
QTIP follows the cycle of OPNFV Releases which is approximately one release every half year.
The tasks are organized by sprints, three weeks for each.
The target and content of each sprint is discussed in weekly meeting.
QTIP follows OpenStack Style Guidelines for source code and commit message.
Specially, it is recommended to link each patch set with a JIRA issue. Put
in commit message to create an automatic link.
The implementation, including new features and bug fix, must be covered by unit test. The criteria for test coverage in QTIP project are as following:
=80% coverage for each file
=90% overall coverage for whole project
The documents are built automatically by sphinx from reStructuredText (reST). Please read reStructuredText Primer if you are not familiar with it.
Start a new document by copying an example from
Frequent Asked Questions
Q: May I work on task which have already been assigned to others?
A: Yes. But please make sure you have contacted the original assignee to avoid overlapping.