summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAgeFilesLines
* CONTRIBUTING.md: Strengthen testing recommendataions.Mark Kavanagh2015-02-151-1/+4
| | | | | | | | | | | | | | Patches that modify existing code can break expected behaviour. Flag this by testing the patch with 'make check' prior to submission. Furthermore, it is not sufficient to only test patches that add files using 'make distcheck'; the compile flags for this target could change the definition of some functions (ovs_assert, for example), altering the outcome of some unit tests. Rather, it is preferable to use a combination of 'make distcheck' with 'make check' to cover all bases. Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* doc: Add more cross references between docsThomas Graf2014-10-301-4/+6
| | | | | | | Suggested-by: Lori Jakab <lojakab@cisco.com> Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Reviewed-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* doc: Convert docs to Markdown languageThomas Graf2014-10-281-0/+318
Converts the majority of docs over to use the Markdown language for pretty printing on GitHub. It's a rough first convertion without exploiting the full potential of Markdown at this point. Section titles and indentation are fixed as needed. Minimal docs interlinking is added. Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Signed-off-by: Ben Pfaff <blp@nicira.com>