XAPI Design and Code Review: Difference between revisions
From Xen
Jump to navigationJump to search
Dave.scott (talk | contribs) (Created page with "The Xapi code repositories are on Github in the [https://github.com/xapi-project xapi-project] organisation. If you want to make a change to Xapi then you should: # if it's a b…") |
Lars.kurth (talk | contribs) (Adding category) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 4: | Line 4: | ||
# if it's a bug: make a pull request with a code fix (maybe simply an experimental one for comments-- don't be shy!) |
# if it's a bug: make a pull request with a code fix (maybe simply an experimental one for comments-- don't be shy!) |
||
# if it's a new feature or impacts multiple components: describe your proposed changes in markdown first in a [https://github.com/xapi-project/xapi-project.github.io/pulls design doc pull request]. This allows the general approach to be checked before you spend too much time coding everything up. |
# if it's a new feature or impacts multiple components: describe your proposed changes in markdown first in a [https://github.com/xapi-project/xapi-project.github.io/pulls design doc pull request]. This allows the general approach to be checked before you spend too much time coding everything up. Assuming everything is ok, you should also produce updates to the relevant technical documentation too, so they don't get out-of-sync. |
||
To understand the level of detail required of a design doc, have a look at the [http://xapi-project.github.io/design-docs/index.html Design Docs Index]. |
|||
In both cases (code changes and doc changes) you should expect prompt feedback. If nothing has happened for a week or so, feel free to comment on the pull request to ask if there has been any progress and/or send an email on the [http://lists.xenproject.org/mailman/listinfo/xen-api xen-api mailing list] |
In both cases (code changes and doc changes) you should expect prompt feedback. If nothing has happened for a week or so, feel free to comment on the pull request to ask if there has been any progress and/or send an email on the [http://lists.xenproject.org/mailman/listinfo/xen-api xen-api mailing list] |
||
If at any point you aren't sure what to do then ask on the [http://lists.xenproject.org/mailman/listinfo/xen-api xen-api mailing list] |
If at any point you aren't sure what to do then ask on the [http://lists.xenproject.org/mailman/listinfo/xen-api xen-api mailing list] |
||
[[Category:XAPI Devel]] |
|||
Latest revision as of 11:14, 21 January 2015
The Xapi code repositories are on Github in the xapi-project organisation.
If you want to make a change to Xapi then you should:
- if it's a bug: make a pull request with a code fix (maybe simply an experimental one for comments-- don't be shy!)
- if it's a new feature or impacts multiple components: describe your proposed changes in markdown first in a design doc pull request. This allows the general approach to be checked before you spend too much time coding everything up. Assuming everything is ok, you should also produce updates to the relevant technical documentation too, so they don't get out-of-sync.
To understand the level of detail required of a design doc, have a look at the Design Docs Index.
In both cases (code changes and doc changes) you should expect prompt feedback. If nothing has happened for a week or so, feel free to comment on the pull request to ask if there has been any progress and/or send an email on the xen-api mailing list
If at any point you aren't sure what to do then ask on the xen-api mailing list
