From 73a4dc4a87258b7b4382d1ef965c4258aeeb2e89 Mon Sep 17 00:00:00 2001 From: Sullivan SENECHAL Date: Tue, 12 Apr 2016 11:45:08 +0200 Subject: [PATCH] Move contributing section and proper rename readme --- Readme.md => CONTRIBUTING.md | 13 +++---------- README.md | 9 +++++++++ 2 files changed, 12 insertions(+), 10 deletions(-) rename Readme.md => CONTRIBUTING.md (90%) create mode 100644 README.md diff --git a/Readme.md b/CONTRIBUTING.md similarity index 90% rename from Readme.md rename to CONTRIBUTING.md index 965c3cc..4820fa6 100644 --- a/Readme.md +++ b/CONTRIBUTING.md @@ -1,14 +1,8 @@ -# Top horizontal menu - -## About - -Adds a new horizontal menu to the top of your e-commerce website. - -## Contributing +# Contributing PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements. -### Requirements +## Requirements Contributors **must** follow the following rules: @@ -16,7 +10,7 @@ Contributors **must** follow the following rules: * Do not update the module's version number. * Follow [the coding standards][1]. -### Process in details +## Process in details Contributors wishing to edit a module's files should follow the following process: @@ -34,4 +28,3 @@ That's it: you have contributed to this open-source project! Congratulations! [1]: http://doc.prestashop.com/display/PS16/Coding+Standards [2]: http://doc.prestashop.com/display/PS16/How+to+write+a+commit+message [3]: https://help.github.com/articles/using-pull-requests - diff --git a/README.md b/README.md new file mode 100644 index 0000000..0926711 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Top horizontal menu + +## About + +Adds a new horizontal menu to the top of your e-commerce website. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md)