Commit 335932651bb2dd5abe33002804a350fb7055b08d

Vicent Martí 2012-05-23T10:10:04

Merge pull request #723 from carlosmn/rel-notes Add notice about release notes

diff --git a/CONVENTIONS b/CONVENTIONS
index 575cdc5..f082d8e 100644
--- a/CONVENTIONS
+++ b/CONVENTIONS
@@ -49,7 +49,7 @@ Functions should prefer to return a 'int' to indicate success or
 failure and supply any output through the first argument (or first
 few arguments if multiple outputs are supplied).
 
-int status codes are 0 for GIT_SUCCESS and < 0 for an error.
+int status codes are 0 for GIT_OK and < 0 for an error.
 This permits common POSIX result testing:
 
 ----
@@ -58,7 +58,7 @@ This permits common POSIX result testing:
 ----
 
 Functions returning a pointer may return NULL instead of an int
-if there is only one type of failure (ENOMEM).
+if there is only one type of failure (GIT_ENOMEM).
 
 Functions returning a pointer may also return NULL if the common
 case needed by the application is strictly success/failure and a
diff --git a/README.md b/README.md
index b0c0db1..871b7da 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,9 @@ How Can I Contribute?
 ==================================
 
 Fork libgit2/libgit2 on GitHub, add your improvement, push it to a branch
-in your fork named for the topic, send a pull request.
+in your fork named for the topic, send a pull request. If you change the
+API or make other large changes, make a note of it in docs/RelNotes/ in a
+file named after the next release.
 
 You can also file bugs or feature requests under the libgit2 project on
 GitHub, or join us on the mailing list by sending an email to: