diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0db2658f73..249c96c9e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,18 @@ Thanks for your interest in contributing to OpenLayers 3. +## Asking Questions + +Please ask questions about using the library on [stackoverflow using the tag 'openlayers-3'](http://stackoverflow.com/questions/tagged/openlayers-3). + +When you want to get involved and discuss new features or changes, please use [the mailing list](https://groups.google.com/forum/#!forum/ol3-dev). + + +## Submitting Bug Reports + +Please use the [GitHub issue tracker](https://github.com/openlayers/ol3/issues). Before creating a new issue, do a quick search to see if the problem has been reported already. + + ## Contributing Code Our preferred means of receiving contributions is through [pull requests](https://help.github.com/articles/using-pull-requests). Make sure @@ -25,7 +37,7 @@ You will obviously start by ### Travis CI -The Travis CI hook is enabled on the Github repository. This means every pull request +The Travis CI hook is enabled on the Github repository. This means every pull request is run through a full test suite to ensure it compiles and passes the tests. Failing pull requests will not be merged. @@ -78,7 +90,7 @@ The `build.py` script is equivalent to a Makefile. It is actually based on The usage of the script is: $ ./build.py - + where `` is the name of the build target you want to execute. For example: diff --git a/README.md b/README.md index 8c8f7324f1..265727a5fb 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,5 @@ Welcome to [OpenLayers 3](http://openlayers.org/)! ## Examples Check out the [hosted examples](http://openlayers.org/en/master/examples/), the [workshop](http://openlayers.org/ol3-workshop/) or poke around the evolving [API docs](http://openlayers.org/en/master/apidoc/). -## Questions -Please don't ask questions in the github issue tracker but use [stackoverflow with tag openlayers](http://stackoverflow.com/questions/tagged/openlayers) or [the mailing list](https://groups.google.com/forum/#!forum/ol3-dev) instead. - ## Contributing Please see our guide on [contributing](CONTRIBUTING.md) if you're interested in getting involved. diff --git a/doc/index.hbs b/doc/index.hbs index 6d4a002579..8f2e24090a 100644 --- a/doc/index.hbs +++ b/doc/index.hbs @@ -12,3 +12,7 @@ For a more in-depth overview of OpenLayers 3 core concepts, check out the [tutor Make sure to also check out the [OpenLayers 3 workshop](../../../ol3-workshop/). Find additional reference material in the [API docs](../apidoc). + +# Questions + +If you cannot find an answer in the documentation, you can ask your question on [stackoverflow using the tag 'openlayers-3'](http://stackoverflow.com/questions/tagged/openlayers-3).