Added initial CONTRIBUTING.md

agner · Jan 28, 2011 · b44768c · b44768c
1 parent 474b872
commit b44768c
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+CONTRIBUTING
+============
+
+How can I suggest a new package?
+--------------------------------
+
+Just [open an issue](https://github.com/agner/agner/issues) with your suggestion.
+
+How can I create a new package?
+-------------------------------
+
+You can create a spec repository by forking and renaming [template package repo](https://github.com/agner/agner.template)
+and later on submitting it for inclusion by [opening an issue](https://github.com/agner/agner/issues). 
+The last step is only necessary if you want this package to be published on a "central" index. 
+If you want to keep it semi-private, you can just use it from your own index.
+
+Before commiting your agner.config, please make sure you ran `agner verify` on it so it passes at least
+some validity checks.
diff --git a/README.md b/README.md
@@ -295,4 +295,4 @@ You can also specify your own indices:
 Contributing
 ------------
 
-Please read at the [wiki](https://github.com/agner/agner/wiki/Contributing).
+Please read at [CONTRIBUTING](agner/tree/master/CONTRIBUTING.md).