aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristian Aune <kraune@yahoo-inc.com>2017-08-22 15:55:00 +0200
committerKristian Aune <kraune@yahoo-inc.com>2017-08-22 15:55:00 +0200
commit6fb8911630f77904735b67a6988791abe420b7ee (patch)
tree240cd7b0d469b27ce955842c8f87efb5c26414e6
parent71465ddf00e30f192ee563b547b972bb93050d04 (diff)
skeleton doc, first cut
-rw-r--r--CONTRIBUTING.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000000..d61b3b67a55
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing to Vespa
+We appreciate contributions to Vespa!
+Below is a quick how-to
+
+
+## Reporting issues
+Reporting a problem is a valuable contribution.
+Use GitHub issues to report bugs. Issues are evaluated almost daily
+
+
+## Check the ToDo list
+Future features are kept on the [ToDo list](TODO.md) -
+minor fixes better reported in issues.
+
+
+## Build custom plugins
+Vespa has great support for custom plugins -
+you will often find that the best way to implement your application is by writing a plugin -
+refer to the [APIs](http://docs.vespa.ai/documentation/api.html).
+
+
+## Where to start contributing
+Most features plug into the Vespa Container - this is the most likely pleace to write enhancements.
+Discuss with the community if others have similar feature requests - make the feature generic.
+
+### Getting started
+Build and test Vespa ... See [README](README.md)
+
+### Pull requests
+The Vespa Team evaluates pull requests as fast as we can ...
+
+## Community
+List here - Slack channel?