From 4adcaa8b293f051db3c90f656787436a35212e09 Mon Sep 17 00:00:00 2001 From: Kristian Aune Date: Wed, 23 Aug 2017 09:30:39 +0200 Subject: more details and links --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d61b3b67a55..33fe2ea4f1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,29 @@ # Contributing to Vespa We appreciate contributions to Vespa! -Below is a quick how-to +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 +Use [GitHub issues](https://github.com/vespa-engine/vespa/issues) to report bugs. +Issues are evaluated daily. +If you read this, you are probably a developer who knows how to write good bug reports - +make it easy to for others to reproduce the problem (include a test case!), +include the Vespa version, +and make it easy for others to understand the importance of the problem. ## Check the ToDo list Future features are kept on the [ToDo list](TODO.md) - -minor fixes better reported in issues. +minor fixes better reported and tracked in [issues](https://github.com/vespa-engine/vespa/issues). + + +## Versioning +Vespa uses semantic versioning, +read [this guide](http://docs.vespa.ai/documentation/vespa-versions.html) to understand +deprecations and changes to APIs and stored data across releases. +Vespa releases more often than weekly, and the team does not write release notes or a changelog - +instead, track issues labeled _Feature_. ## Build custom plugins @@ -20,14 +33,28 @@ 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. +Most features plug into the [Vespa Container](docs.vespa.ai/documentation/jdisc/index.html) - +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) +See [README](README.md) for how to build and test Vespa. + +Java coding guidelines: +* 4 spaces indent +* Use Java coding standards +* No wildcard imports ### Pull requests -The Vespa Team evaluates pull requests as fast as we can ... +The Vespa Team evaluates pull requests as fast as we can. +File an issue that you can refer to in the pull request - +The issue can be valid even though a pull request will not be merged. +Also add `Closes #XXX` or `Fixes #XXX` in commits - this will auto-close the issue. +The Vespa Team work on the master branch, and does not have branches for other major versions - +the current major version is the only active. +Submit unit tests with the changes and [update documentation](https://github.com/vespa-engine/documentation). + + ## Community List here - Slack channel? -- cgit v1.2.3