diff --git a/Legal/Individual Contributor License Agreement.md b/Legal/Individual Contributor License Agreement.md new file mode 100644 index 0000000..019045f --- /dev/null +++ b/Legal/Individual Contributor License Agreement.md @@ -0,0 +1,49 @@ +# Individual Contributor License Agreement ("CLA") 1.0 + +Thank you for your interest in Karaka-Management (the "Company"). In order to clarify the intellectual property license granted with Contributions from any person or entity, the Company must provide a Contributor License Agreement ("CLA") on file that has been made available to each Contributor. This license is for your protection as a Contributor as well as the protection of the Company and its users; it does not change your rights to use your own Contributions for any other purpose. + +By contributing to the Company You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Company. In return, the Company shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its bylaws in effect at the time of the Contribution. Except for the license granted herein to the Company and recipients of software distributed by the Company, You reserve all right, title, and interest in and to Your Contributions. + +## Definitions + +**"You" (or "Your")** + +"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Company. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +**"Contribution"** + +"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Company for inclusion in, or documentation of, any of the products owned or managed by the Company (the "Work"). This includes but is not limited to technical material, techniques, articles, sketches, drawings, images, models, inventions, know-how, processes, apparatus, equipment, algorithms, software programs, software source documents, and formula related to the current, future and proposed products and services regarding the Company". For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Company or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Company for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." + +## Grant of Copyright License + +Subject to the terms and conditions of this Agreement, You hereby grant to the Company and to recipients of software distributed by the Company a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sub license, and distribute Your Contributions and such derivative works. + +## Grant of Patent License + +Subject to the terms and conditions of this Agreement, You hereby grant to the Company and to recipients of software distributed by the Company a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. + +## Authorization + +You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Company, or that your employer has executed a separate Corporate CLA with the Company. + +You represent that each of Your Contributions is Your original creation (see "Third-party Contribution" for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. + +## Support + +You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. + +## Third-party Contribution + +Should You wish to submit work that is not Your original creation, You may submit it to the Company separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". + +## Survival + +This Agreement shall govern all communications between the parties. You understand that this Agreement stays active even if the connection with You gets terminated unless the project the Company gets officially canceled by the project manager "Dennis Eichhorn". + +## Governing Law and Jurisdiction + +This Agreement shall be governed exclusively by German law. The courts of Hessen, Germany shall have exclusive jurisdiction. + +## Entire Agreement + +This agreement constitutes the entire agreement and supersedes all prior or contemporaneous oral or written agreements concerning such Contribution. This agreement may only be changed by mutual agreement of authorized representatives of the parties in writing. You agree to notify the Company of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. \ No newline at end of file diff --git a/Legal/License.md b/Legal/License.md new file mode 100644 index 0000000..20c49ac --- /dev/null +++ b/Legal/License.md @@ -0,0 +1,15 @@ +The OMS License 1.0 + +Copyright (c) All Rights Reserved + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +BY CONTRIBUTING YOU AUTOMATICALLY ACCEPT THE INDIVIDUAL CONTRIBUTOR LICENSE +AGREEMENT 1.0 ("CLA") INCLUDED IN THIS REPOSITORY. + diff --git a/Policies & Guidelines/Code of conduct.md b/Policies & Guidelines/Code of Conduct.md similarity index 89% rename from Policies & Guidelines/Code of conduct.md rename to Policies & Guidelines/Code of Conduct.md index 1b14538..c4c3d7f 100644 --- a/Policies & Guidelines/Code of conduct.md +++ b/Policies & Guidelines/Code of Conduct.md @@ -34,9 +34,9 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at spl1nes.com@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at spl1nes.com@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. +Disrespecting this policy possibly leads to a warning and potnetially excluding the involved person from any further activities of the organization. Depending on the severness legal actions may follow. ## Attribution diff --git a/Policies & Guidelines/Confidentiality Policy.md b/Policies & Guidelines/Confidentiality Policy.md index cdcb288..7bb3cea 100644 --- a/Policies & Guidelines/Confidentiality Policy.md +++ b/Policies & Guidelines/Confidentiality Policy.md @@ -40,10 +40,14 @@ Confidential information may occasionally have to be disclosed for legitimate re Disclosing more information than needed must be avoided. -## Consequences +## Enforcement -Disrespecting this policy possibly leads to legal actions. +Disrespecting this policy possibly leads to a warning and potnetially excluding the involved person from any further activities of the organization. Depending on the severness legal actions may follow. ## Survival This policy is binding even after separation. + + + +2022.01.01 - Version 1.0 diff --git a/Policies & Guidelines/Conflict of Interest Policy.md b/Policies & Guidelines/Conflict of Interest Policy.md index dbe39d7..e7761f1 100644 --- a/Policies & Guidelines/Conflict of Interest Policy.md +++ b/Policies & Guidelines/Conflict of Interest Policy.md @@ -28,6 +28,10 @@ In general it is advised to refrain from letting personal and/or financial inter All conflicts of interest will be resolved as fairly as possible. Senior organization members have the responsibility of the final decision when a solution can be found. -## Consequences +## Enforcement -Disrespecting this policy possibly leads to legal actions or excluding the involved person from any further activities of the organization if no solution can be found. +Disrespecting this policy possibly leads to a warning and potnetially excluding the involved person from any further activities of the organization. Depending on the severness legal actions may follow. + + + +2022.01.01 - Version 1.0 diff --git a/Policies & Guidelines/Organization Activity Policy.md b/Policies & Guidelines/Organization Activity Policy.md index 9f71488..9148468 100644 --- a/Policies & Guidelines/Organization Activity Policy.md +++ b/Policies & Guidelines/Organization Activity Policy.md @@ -6,4 +6,10 @@ The organization doesn't define any fixed hours and expects the members to decid Members should not spend more than 40 hours per week on the organization as we believe output quality will drastically reduce over time. -Extremely few or insignificant contributions may lead to the exclusion from the organization based on judgmental basis by a senior member. A member can expect to receive a warning in advance in order to provide the chance to increase the activity or provide reasons for the past activities. \ No newline at end of file +## Enforcement + +Extremely few or insignificant contributions may lead to the exclusion from the organization based on judgmental basis by a senior member. A member can expect to receive a warning in advance in order to provide the chance to increase the activity or provide reasons for the past activities. + + + +2022.01.01 - Version 1.0 \ No newline at end of file diff --git a/Policies & Guidelines/Organization Guidelines.md b/Policies & Guidelines/Organization Guidelines.md index 5dcbca6..dd7cbca 100644 --- a/Policies & Guidelines/Organization Guidelines.md +++ b/Policies & Guidelines/Organization Guidelines.md @@ -15,3 +15,11 @@ We are always open to accept talented or striving people to the organization. We ## Products & Services Our goal is to provide products and services at the highest quality to make our customers, members and partners in general happy. Our products are constantly improved and revised. While providing a high quality product is very important to us; at least as important to us are the services we provide. + +## Enforcement + +Disrespecting this policy possibly leads to a warning and potnetially excluding the involved person from any further activities of the organization. Depending on the severness legal actions may follow. + + + +2022.01.01 - Version 1.0 diff --git a/Processes/COSO/CLC.md b/Processes/COSO/CLC.md index 215fc14..2e1588f 100644 --- a/Processes/COSO/CLC.md +++ b/Processes/COSO/CLC.md @@ -1,45 +1,45 @@ # Company Level Controls (CLC) -| No. | Component | Control Area | Question | Answer | Evidence | -| ---- | ----------------------------- | ------------------------------------- | ------------------------------------------------------------ | ------ | -------- | -| | Control Environment | Principle of financial reporting | Do you have basic financial reporting policies? | | | -| | Control Environment | Understanding accounting policies | Are the selected accounting principles approved? | | | -| | Control Environment | Management philosophy and application | Does management determine the management philosophy, operating style and code of ethics and manifest them to employees? | | | -| | Control Environment | Management philosophy and application | Do you have any procedures or processes to remediate detected behaviors deviating from the management philosophy, operating style and code of ethics | | | -| | Control Environment | Management philosophy and application | In case you find deviations from the principles, do you deal with them according to the predetermined procedures or processes? | | | -| | Control Environment | Director | Do you have any company rules to clearly specify that the board of directors or a director in charge have responsibilities for appropriately supervising and monitoring the management in regard to the financial reporting and relevant internal controls? | | | -| | Control Environment | Director | Does the board of directors or corporate auditors supervise the performance of management regard the financial reporting and relevant internal controls? | | | -| | Control Environment | Organization | Does the management appropriately improve organizational structures or practices to resolve existing problems considering the size, content of the operations and business objectives of the company? | | | -| | Control Environment | Organization | Does the management assign roles in regard to each function and activity unit in the company? | | | -| | Control Environment | Organization | Do you have any rules to clarify segregation of duties and appropriately delegate authority and responsibilities to personnel in charge of each function and activity unit in the company? | | | -| | Control Environment | Organization | Does the management assign a person in charge for each role? | | | -| | Control Environment | Power | Are the assignment of responsibilities and delegation of authority made clear to all employees? | | | -| | Control Environment | Power | Is the delegation of responsibilities and authority to employees, etc. kept at appropriate levels, not without limitation? | | | -| | Control Environment | Power | Are the delegation of responsibilities and authority to employees, etc. updated on a timely basis in case organizational structures or other fundamentals of the company are changed? | | | -| | Control Activities | Business procedure | Are policies and procedures or operating manuals established to ensure the performance of control activities that sufficiently mitigate and address the risks in business operations, especially in regard to the reliability of the financial reporting? | | | -| | Control Activities | Business procedure | How do you confirm if employees perform their operations in compliance with policies and procedures or operating manuals? | | | -| | Control Environment | Personnel deployment and training | Does the management identify the competencies necessary for the company and procure/dispatch qualified personnel | | | -| | Control Environment | Personnel deployment and training | Are the competencies necessary reviewed regularly and maintained appropriately? | | | -| | Control Environment | Personnel deployment and training | Does the management provide employees, etc. with the means, training etc. necessary to fulfill their duties and support them in the improvement of their abilities? | | | -| | Control Environment | Personnel evaluation | Do you have personnel evaluation standards? | | | -| | Control Environment | Personnel evaluation | Are the personnel evaluation standards regularly reviewed and updated appropriately? | | | -| | Risk Assessment and Response | Risk assessment structure | Is there an effective risk assessment system that involves appropriate levels of the management and managers? | | | -| | Risk Assessment and Response | Risk assessment structure | Does the management asses the risk considering not only superficial facts but also backgrounds, incidents and other substantial elements? | | | -| | Risk Assessment and Response | Risk assessment structure | Does the management appropriately assess and address fraud risks based on not only superficial facts regarding fraud, but also incentives, causes, backgrounds and other factors that may result in fraud? | | | -| | Risk Assessment and Response | Risk assessment structure | Does the management reassess the risk and take appropriate measures whenever changes occur that may have a significant impact on the company? | | | -| | Communication and information | Communicating information | Are the management's or supervisor's instruction communicated to all employees? | | | -| | Communication and information | Communicating information | Is a system set in place to ensure that external information on internal controls is properly utilized and adequately communicated to the management or internal audit section? | | | -| | Communication and information | Internal reporting | Do you have the Whistleblower System or other internal reporting program? | | | -| | Communication and information | Internal reporting | Is the system or program in operation according to its original design? | | | -| | Communication and information | Financial information | How does the management acquire or access the accounting and financial information of the company? | | | -| | Communication and information | Financial information | How are the accounting and financial information or data from relevant business processes input to your accounting system or application? | | | -| | Communication and information | Information sharing with managements | Do you have any internal rules documents which stipulate that the managements should share business an other information with each other | | | -| | Communication and information | Information sharing with managements | Does your management share information with each other in actual business? | | | -| | Monitoring | Ongoing monitoring | Are ongoing monitoring activities appropriately embedded within the company's overall business operations? | | | -| | Monitoring | Ongoing monitoring | Are the ongoing monitoring activities operated appropriately according to the original designs and purposes? | | | -| | Monitoring | Independent monitoring | Do you have any independent monitoring system other than ongoing monitoring activities embedded within the company's business operations, such as internal audits? | | | -| | Monitoring | Independent monitoring | Are the ongoing monitoring activities operated appropriately according to the original designs and purposes | | | -| | Monitoring | Response to results of monitoring | Are errors, material weakness of internal controls, etc. detected through the performance of control activities or noticed from outside the company timely reported to the management or senior managers and appropriately investigated and properly addressed? | | | +| No. | Component | Control Area | Question | Answer | Evidence | +| ---- | ----------------------------- | ------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| | Control Environment | Principle of financial reporting | Do you have basic financial reporting policies? | Yes, the organization follows the German law regarding financial reporting | Financial laws (i.e. HGB, AO, Ustg, ...) | +| | Control Environment | Understanding accounting policies | Are the selected accounting principles approved? | Yes, employees are required to act according to the the German law | Financial laws (i.e. HGB, AO, Ustg, ...) | +| | Control Environment | Management philosophy and application | Does management determine the management philosophy, operating style and code of ethics and manifest them to employees? | Yes, all are described in the organization guidelines | Code of Conduct
Organization Guidelines
Conflict of Interest Policy
Confidentiality Policy | +| | Control Environment | Management philosophy and application | Do you have any procedures or processes to remediate detected behaviors deviating from the management philosophy, operating style and code of ethics | Yes, public email to submit deviating behavior, public discussion and issue tracker to bring forward deviating behavior | Code of Conduct
[Discussions](https://github.com/orgs/Karaka-Management/discussions)
[Issues](https://github.com/Karaka-Management/Karaka/issues) | +| | Control Environment | Management philosophy and application | In case you find deviations from the principles, do you deal with them according to the predetermined procedures or processes? | Yes, so far no such case ocured | Code of Conduct
Organization Guidelines
Conflict of Interest Policy
Confidentiality Policy | +| | Control Environment | Director | Do you have any company rules to clearly specify that the board of directors or a director in charge have responsibilities for appropriately supervising and monitoring the management in regard to the financial reporting and relevant internal controls? | No, apart from the legal obligations | | +| | Control Environment | Director | Does the board of directors or corporate auditors supervise the performance of management regard the financial reporting and relevant internal controls? | Yes, financial controls are audited by independent auditors | Annual year end audit | +| | Control Environment | Organization | Does the management appropriately improve organizational structures or practices to resolve existing problems considering the size, content of the operations and business objectives of the company? | | | +| | Control Environment | Organization | Does the management assign roles in regard to each function and activity unit in the company? | | | +| | Control Environment | Organization | Do you have any rules to clarify segregation of duties and appropriately delegate authority and responsibilities to personnel in charge of each function and activity unit in the company? | | | +| | Control Environment | Organization | Does the management assign a person in charge for each role? | | | +| | Control Environment | Power | Are the assignment of responsibilities and delegation of authority made clear to all employees? | | | +| | Control Environment | Power | Is the delegation of responsibilities and authority to employees, etc. kept at appropriate levels, not without limitation? | | | +| | Control Environment | Power | Are the delegation of responsibilities and authority to employees, etc. updated on a timely basis in case organizational structures or other fundamentals of the company are changed? | | | +| | Control Activities | Business procedure | Are policies and procedures or operating manuals established to ensure the performance of control activities that sufficiently mitigate and address the risks in business operations, especially in regard to the reliability of the financial reporting? | | | +| | Control Activities | Business procedure | How do you confirm if employees perform their operations in compliance with policies and procedures or operating manuals? | | | +| | Control Environment | Personnel deployment and training | Does the management identify the competencies necessary for the company and procure/dispatch qualified personnel | | | +| | Control Environment | Personnel deployment and training | Are the competencies necessary reviewed regularly and maintained appropriately? | | | +| | Control Environment | Personnel deployment and training | Does the management provide employees, etc. with the means, training etc. necessary to fulfill their duties and support them in the improvement of their abilities? | | | +| | Control Environment | Personnel evaluation | Do you have personnel evaluation standards? | | | +| | Control Environment | Personnel evaluation | Are the personnel evaluation standards regularly reviewed and updated appropriately? | | | +| | Risk Assessment and Response | Risk assessment structure | Is there an effective risk assessment system that involves appropriate levels of the management and managers? | | | +| | Risk Assessment and Response | Risk assessment structure | Does the management asses the risk considering not only superficial facts but also backgrounds, incidents and other substantial elements? | | | +| | Risk Assessment and Response | Risk assessment structure | Does the management appropriately assess and address fraud risks based on not only superficial facts regarding fraud, but also incentives, causes, backgrounds and other factors that may result in fraud? | | | +| | Risk Assessment and Response | Risk assessment structure | Does the management reassess the risk and take appropriate measures whenever changes occur that may have a significant impact on the company? | | | +| | Communication and information | Communicating information | Are the management's or supervisor's instruction communicated to all employees? | | | +| | Communication and information | Communicating information | Is a system set in place to ensure that external information on internal controls is properly utilized and adequately communicated to the management or internal audit section? | | | +| | Communication and information | Internal reporting | Do you have the Whistleblower System or other internal reporting program? | | | +| | Communication and information | Internal reporting | Is the system or program in operation according to its original design? | | | +| | Communication and information | Financial information | How does the management acquire or access the accounting and financial information of the company? | | | +| | Communication and information | Financial information | How are the accounting and financial information or data from relevant business processes input to your accounting system or application? | | | +| | Communication and information | Information sharing with managements | Do you have any internal rules documents which stipulate that the managements should share business an other information with each other | | | +| | Communication and information | Information sharing with managements | Does your management share information with each other in actual business? | | | +| | Monitoring | Ongoing monitoring | Are ongoing monitoring activities appropriately embedded within the company's overall business operations? | | | +| | Monitoring | Ongoing monitoring | Are the ongoing monitoring activities operated appropriately according to the original designs and purposes? | | | +| | Monitoring | Independent monitoring | Do you have any independent monitoring system other than ongoing monitoring activities embedded within the company's business operations, such as internal audits? | | | +| | Monitoring | Independent monitoring | Are the ongoing monitoring activities operated appropriately according to the original designs and purposes | | | +| | Monitoring | Response to results of monitoring | Are errors, material weakness of internal controls, etc. detected through the performance of control activities or noticed from outside the company timely reported to the management or senior managers and appropriately investigated and properly addressed? | | | diff --git a/Processes/COSO/ITGC.md b/Processes/COSO/ITGC.md index c7e4b37..cf630a8 100644 --- a/Processes/COSO/ITGC.md +++ b/Processes/COSO/ITGC.md @@ -36,8 +36,6 @@ | 4 | Changes are approved for their migration to the production environment | | | | | 5 | Procedures are in place for preventing/detecting unauthorized changes to the production environment | | | | - - ## System Security (Access Control) ### Points to consider @@ -81,7 +79,7 @@ | No. | Question | Situation | Evidence | | ---- | ------------------------------------------------------------ | ----------------------------------------------------------- | -------- | -| 1 | Poliicies and procedures for backups | Exists | | +| 1 | Policies and procedures for backups | Exists | | | 2 | Completion of backup is ensured | All backup job records are reviewed by monitoring personnel | | | 3 | Backup and recovery are periodically tested | | | | 4 | Policies and procedures for job operation are described in a documentation | | | diff --git a/Processes/Development.md b/Processes/Development.md index 23639cc..0f4a828 100644 --- a/Processes/Development.md +++ b/Processes/Development.md @@ -28,12 +28,30 @@ Code changes must follow the [style guidelines](https://github.com/Karaka-Manage In rare cases errors, failures or warnings during the automatic inspection are acceptable. Reasons can be changes in the programming language, special cases which cannot, are difficult or must be individually configured in the inspection settings. If this is the case for a code change and if inspection configuration changes are necessary are decided by the senior developer performing the code review. +Automated checks which are run during the review process: + +```sh +php ./vendor/bin/phpcs ./ --standard="Build/Config/phpcs.xml" +npx eslint ./ -c ./Build/Config/.eslintrc.json +``` + ### Tests Code changes must follow the inspection guidelines (i.e. code coverage) mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md). Developers should check if the code changes comply with the inspection guidelines before submitting them. In rare cases it might be not possible to follow the inspection guidelines. In such cases the senior developer performing the code review may decide if the code change still gets accepted. +Automated tests which are run during the review process: + +```sh +php ./vendor/bin/phpunit -c tests/PHPUnit/phpunit_default.xml +php ./vendor/bin/phpstan analyse --autoload-file=phpOMS/Autoloader.php -l 9 -c Build/Config/phpstan.neon ./ +npx jasmine-node ./ +./cOMS/tests/test.sh +``` + +Additional inspections which are run but might be ignored during the review depending on the use case are mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) as other checks. + ### Demo Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script try to simulate a real world use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. @@ -50,7 +68,7 @@ If the code reviewer only finds minor issues with the proposed code change the r Code changes must be performed in a new branch. A new branch can be created with: -```ssh +```sh git checkout -b new-branch-name ``` diff --git a/Project/PROJECT.md b/Project/PROJECT.md index d129217..aa48186 100644 --- a/Project/PROJECT.md +++ b/Project/PROJECT.md @@ -3,6 +3,8 @@ - [Summary](#summary) - [Most recent changelog](#most-recent-changelog) - [Milestones](#milestones) +- [Milestone tasks](#milestone-tasks) +- [Todos](#todos) - [Bugs](#bugs) - [Drafts, concepts & ideas](#drafts-concepts-ideas) @@ -316,7 +318,9 @@ Todos/tasks which are not important enough to be part of the milestones (or don' | high | Forms | Invalid api responses should undo the UI changes | | high | Forms | Adding a template to the DOM should modify its id/generate a custom/random id for the added element | | high | Forms | If a form has unsaved content the browser should ask if the user really wants to change the page or close it (use beforeunload event). | +| medium | Job | Consider to run jobs through the cli application. This means a job executes `php cli.php put:/admin/job -i 3` which runs the command of job 3. This would allow to log the job execution time and response. If you don't want to wait for the execution to finish you may as well run it async (this means of course no execution time or output can be logged, but at least the start time). | | medium | CMS | Create functionality which allows to replace application files. Instead of just overwriting them they get backed up in a backup directory. | +| medium | UI select | Bind data to select options such as visible elements and data pre-fills. When an option is selected certain ui elements become visible and get filled out with default values. | | medium | Knowledgebase | Add org ID to wiki app (optional) and add a default flag. In the backend load the default wiki app for the current organization `$this->app->orgId` | | medium | Tasks | Allow to create a reminder for a task (e.g. small bell next to the user name which highlights the task/removes the has_seen flag + says somewhere you got remindered) | | medium | Tasks | Create different overviews list by date + list by priority (very high + next day, high + next 2 days, medium + next 5 days, low + next 10 days, very low + remaining). Of course the grouping may change based on how long ago the creation date is. | @@ -606,11 +610,3 @@ Software: 1. Tesseract + OpenCV + above mentioned steps 2. Some Api (e.g. google vision ai, amazon textract, amazon recognition) - -### Form - -1. A form has 2 parts: - 1. Data representation (e.g. table) - 2. Data add/update (e.g. inline or external form) **already solved** - 1. Inline: input elements are created in the data representation - 2. External: single or multiple external forms