From b1199cb8e75533ef10ca2c6895ab1c53e182e29e Mon Sep 17 00:00:00 2001 From: Shreesh Arora <55269017+shreesh-webkul@users.noreply.github.com> Date: Wed, 12 Apr 2023 16:35:58 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 76 +++++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 472d014f5..f1481b896 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,49 +1,57 @@ -Contributing to PrestaShop --------------------------- +# Contribute to QloApps -PrestaShop is an open-source e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements. +QloApps is an open-source software and we all know that community contributions lie at the heart of any open-source software. It is the essence of an open-source that a diverse group of individuals collaborate and innovate the best possible solutions. -PrestaShop 1.6 is written mostly in PHP. Other languages used throughout are JavaScript, HTML, CSS, the Smarty templating language, SQL, and XML. +Here are the ways you can contribute to the QloApps project. -To contribute to the project, you should ideally be familiar with Git, the source code management system that PrestaShop uses, with the official repository being hosted on Github: -* You can learn more about Git here: http://try.github.io/ (there are many tutorials available on the Web). -* You can get help on Github here: https://help.github.com/. -* Windows users can get a nice interface for Git by installing TortoiseGit: http://code.google.com/p/tortoisegit/ +## Code Enhancements -Contributors should follow the following process: +As a PHP developer, if you have command on not only PHP but also MySQL and also know how to use Git and GitHub efficiently you can contribute to code enhancements via [pull requests on GitHub](https://github.com/webkul/hotelcommerce/pulls). -1. Create your Github account, if you do not have one already. -2. Fork the PrestaShop project to your Github account. -3. Clone your fork to your local machine. Be sure to make a recursive clone (use "git clone --recursive git://github.com/username/PrestaShop.git" or check the "Recursive" box in TortoiseGit) in order to have all the PrestaShop modules cloned too! -4. Create a branch in your local clone for your changes. -5. Change the files in your branch. Be sure to follow [the coding standards][1]. -6. Push your changed branch to your fork in your Github account. -7. Create a pull request for your changes on the PrestaShop project. Be sure to follow [the commit message norm][2] in your pull request. If you need help to make a pull request, read the [Github help page about creating pull requests][3]. -8. Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code. +### Current Feature Enhancement -That's it: you have contributed to this open source project! Congratulations! +If you feel there is a scope for improvement in any current feature of the system then just send us the pull request with your enhanced codes. The team will review it and if everything is up to the mark then it will be merged with the main branch. -The PrestaShop documentation features a thorough explanation of the [complete process to your first pull request][4]. +In QloApps we follow a modular approach to bring functionalities into the system. The system has its native modules for different features. -If you don't feel comfortable forking the project or using Git, you can also either: -* Edit a file directly within Github: browse to the target file, click the "Edit" button, make your changes in the editor then click on "Propose File Change". Github will automatically create a new fork and branch on your own Github account, then suggest to create a pull request to PrestaShop. Once the pull request is submitted, you just have to wait for a core developer to answer you. -* Submit an issue using the Forge: [PrestaShop Forge][5] is the official ticket-tracker for PrestaShop, and the best place to write a bug ticket or request an improvement, while not having to be a developer at all. You will need to create an account on the Forge: [follow these instructions][6], then wait for a core developer to answer you. +You can also improve these modules besides the core features to improve the features of the system. -Thank you for your help in making PrestaShop even better! +### Addition Of A New Feature + +Any system can never have all the features that satisfy the needs of every business out there. And we all have different mindsets. +So you can always think of a feature that is not there in the system. + +Again we will need your pull requests on GitHub. And if everything is fine we will merge your request into the main branch. + +### Bug Fixing + +The beauty of being an open-source software is that anyone who knows to code can improve your code. + +We always try that keep the system as bug-free as we can. But still, if there is anything left and you have resolved it then send it to us. + +You have to follow the GitHub PR system for bug fixings also. + +### Optimization + +If you have an idea to make the system more optimized and you can make the system work better then it's time to make a pull request at the [QloApps Github repository](https://github.com/webkul/hotelcommerce). + +The better-written code the better the software performance. + +### Report Security Issues + +QloApps values the contributions of the security research community, and we look forward to working with you to minimize risk to QloApps users. + +If you have found a security issue in QloApps, please do not use the issue tracker and don't publish it publicly. Instead, report the security issue to [support@qloapps.com](mailto:support@qloapps.com) or contact [QloApps Support](https://webkul.uvdesk.com/en/customer/create-ticket/). So that we can act on it immediately to avoid as much damage as we can. -### About licenses +## Testing -* All core files you commit in your pull request must respect/use the [Open Software License (OSL 3.0)][7]. -* All modules files you commit in your pull request must respect/use the [Academic Free License (AFL 3.0)][8]. +### Bug Reporting +Bugless development is impossible, we can just try to leave as minimum bugs in the system as we can. At QloApps also we try our best to make the system free of bugs. -[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 -[4]: http://doc.prestashop.com/display/PS16/Contributing+code+to+PrestaShop -[5]: http://forge.prestashop.com/ -[6]: http://doc.prestashop.com/display/PS16/How+to+use+the+Forge+to+contribute+to+PrestaShop -[7]: http://opensource.org/licenses/OSL-3.0 -[8]: http://opensource.org/licenses/AFL-3.0 +Every release goes through a process of quality analysis before reaching you. But as we know it is a huge software with a lot of code files, so there is a possibility that there is any bug left. +So we need you to report any bug you find in the system to our QA Team. Our team will check the bug and find the best possible solution to resolve it. + +You can report a bug either on our GitHub [Issues](https://github.com/webkul/hotelcommerce/issues) or on our [Forum](http://forums.qloapps.com/).