diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b50872d --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +#Gitignore file +.DS_Store \ No newline at end of file diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..34ece02 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,18 @@ +# Thank you! – everyone that help! + +In this document we recommend writing a little about how the project was created and pay tribute to the contributors. + +Here is a list of MUCH-APPRECIATED CONTRIBUTORS -- +people who laid the groundwork, have written code, reported bugs, added +documentation, helped answer questions, and generally made **OS2produkt** that much +better: + +* John Doe +* Jane Doe +* Billy Idol + +A big THANK YOU goes to: + +All municipalities who initiated the project: LIST NAMES here. + +**Maybe mention the vendors** for their excellent guidance and support. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6a233d9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,72 @@ +# Change Log in OS2 projects/products + +All notable changes to the project MUST be documented in this file. + +The format can be based on [Keep a Changelog](http://keepachangelog.com/) +and the project versioning could adher to [Semantic Versioning](http://semver.org/). + +## Guiding Principles + +* Changelogs are for humans, not machines. +* There should be an entry for every single version. +* The same types of changes should be grouped. +* Versions and sections should be linkable. +* The latest version comes first. +* The release date of each version is displayed. +* Mention whether you follow Semantic Versioning. + +## Types of changes + +* Added for new features. +* Changed for changes in existing functionality. +* Deprecated for soon-to-be removed features. +* Removed for now removed features. +* Fixed for any bug fixes. +* Security in case of vulnerabilitie + +# Example + +## [Unreleased] - yyyy-mm-dd + +Here we write upgrading notes for brands. It's a team effort to make them as +straightforward as possible. + +### Added +- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) + MINOR Ticket title goes here. +- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) + PATCH Ticket title goes here. + +### Changed + +### Fixed + +## [1.2.4] - 2017-03-15 + +Here we would have the update steps for 1.2.4 for people to follow. + +### Added + +### Changed + +- [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) + PATCH Drupal.org is now used for composer. + +### Fixed + +- [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) + PATCH Add logic to runsheet teaser delete to delete corresponding + schedule cards. + +## [1.2.3] - 2017-03-14 + +### Added + +### Changed + +### Fixed + +- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) + MINOR Fix module foo tests +- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) + MAJOR Module foo's timeline uses the browser timezone for date resolution \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a8e468a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,7 @@ +# Code of Conduct + +In the interest of fostering an open and welcoming environment we pledge to making participation in our project and our community a harassment-free experience for everyone. + +Please refer to the general [Code of Conduct for OS2](https://os2.eu/side/code-conduct) + +If the project is in need of a project specific CoC you can refer to [ontributor Covenant](https://www.contributor-covenant.org/) \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f0f7049 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Make contributing easy + +It's important that it is very clear how you can become involved and contribute to a project. + +Therefor: + +* The project MUST have a public issue tracker that accepts suggestions from anyone. In OS2 we use [Jira](https://os2web.atlassian.net/) but a combination with for example Github issues are also okay. +* The project MUST include instructions for how to privately report security issues for responsible disclosure. This can be covered by the [SECURITY](SECURITY.md) file. +* The documentation MUST link to both the public issue tracker and submitted codebase changes, for example in a README file. +* The project MUST have communication channels for users and developers. In OS2 we provide the tools to communicate through email lists and our main website. +* The documentation SHOULD include instructions for how to report potentially security sensitive issues on a closed channel. + +# Example + +# Contribution guidelines for *OS2produkt* + +If you want to contribute to *OS2produkt*, we ask you to follow these guidelines. + +## Reporting bugs +If you have encountered a bug in *OS2produkt*, please check if an issue already exists in the list of existing [issues](https://os2web.atlassian.net/), if such an issue does not exist, you can create one [here](https://os2web.atlassian.net/). When writing the bug report, try to add a clear example that shows how to reproduce said bug. + +## Adding new features +Before making making changes to the code, we advise you to first check the list of existing [issues](https://os2web.atlassian.net/) for OS2produkt to see if an issue for the suggested changes already exists. If such an issue does not exist, you can create one [here](https://os2web.atlassian.net/). Creating an issue gives an opportunity for other developers to give tips even before you start coding. If you are in the early idea phase, or if your feature requires larger changes, you can discuss it with the [projects coordination group](https://os2.eu) or by [contacting OS2 directly](https://os2.eu/kontakt) to make sure you are heading in the right direction. + +### Code style +To keep the code clean and readable, *Please include links to coding standards and tools used:* + +Whenever a branch is pushed or a pull request is made, the code will be checked in CI by the tools mentioned above, so make sure to install these tools and run them locally before pushing branches/making PRs. + +### Forking the repository +In order to implement changes to *OS2produkt* when you do not have rights for the required repository, you must first fork the repository. Once the repository is forked, you can clone it to your local machine. + +### Making the changes +On your local machine, create a new branch, and name it like: +- `feature/some-new-feature`, if the changes implement a new feature +- `issue/some-issue`, if the changes fix an issue + +Once you have made changes or additions to the code, you can commit them (try to keep the commit message descriptive but short). If an issue exists in the issue list for the changes you made, be sure to format your commit message like `"Fixes # -- description of changes made`, where `"` corresponds to the number of the issue on Jira or GitHub. To demonstrate that the changes implement the new feature/fix the issue, make sure to also add tests. + +### Making a pull request +If all changes have been committed, you can push the branch to your fork of the repository and create a pull request to the `master` branch of the *OS2produkt* repository. Your pull request will be reviewed, if applicable feedback will be given and if everything is approved, it will be merged. + +### Reviews on releases + +All pull requests will be reviewed before they are merged to a release branch. As well as being reviewed for functionality and following the code style they will be checked with the steering committee and/or the coordination group for the project. diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..1246993 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,18 @@ +# Governance in the project + +The product/project is part of OS2's portfolio and is maintained according to the model defined by the association OS2. + +## Definitions + +### Project + +### Product + +### Users +are those whose primary relationship to the product/project is to consume/use it's code and othere results. + +### Contributors +are those who make contributions to the product/project, ranging from casual to significant, but who aren't responsible for it's overall success. + +### Maintainers +are those who are responsible for the future of a project's repository (or respositories), whoses decisions affect the project laterally. Maintainers can be thought of as "trustees" or stewards of the project/product. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/Publiccode-yml.md b/Publiccode-yml.md new file mode 100644 index 0000000..cdd0338 --- /dev/null +++ b/Publiccode-yml.md @@ -0,0 +1,9 @@ +# Include a Publiccode.yml file in the project + +Publiccode.yml is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverabile and thus reusable by other entities. + +By including a publiccode.yml file in the root of a repository, and populating it with information about the software, technicians and civil servants can evaluate it. Automatic indexing tools can also be built, since the format is easily readable by both humans and machines. + +Full documentation is available [here](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/index.html). + +A guide explaining how to add the publiccode.yml file to your project can be [found here](https://publiccode.discourse.group/t/how-do-i-add-a-publiccode-yml-file-to-my-project/28). \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..36cdb9e --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# OS2produkt + +This is a template repository describing best practice when creating Open Source products in OS2. + +The readme file must contain a description of the project and references to other documents in the project. + +## Inspired by + +Example content is inspired by other projects: + +* [The Standard for Public Code](https://standard.publiccode.net/) +* [Open Zaak](https://github.com/open-zaak/) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..dfb57e8 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,54 @@ + +# OS2produkt security policies + +The development team is strongly committed to responsible reporting and disclosure of security-related issues. As such, we’ve adopted and follow a set of policies which conform to that ideal and are geared toward allowing us to deliver timely security updates to the official distribution of OS2produkt. + +## Reporting security issues + +**Short version: please report security issues by emailing insert-mail@os2.eu.** + +If you discover security issues in **OS2produkt** or related projects under the same +organization, we request you to disclose these in a *responsible* way by e-mailing to +insert-mail@os2.eu. + +It is extremely useful if you have a reproducible test case and/or clear steps on how to +reproduce the vulnerability. + +Please do not report security issues on the public Github issue tracker or the projects public Jira backlog, as this makes +it visible which exploits exist before a fix is available, potentially comprising a lot +of unprotected instances. + +Once you’ve submitted an issue via email, you should receive an acknowledgment from a +member of the security team as soon as possible, and depending on the action to be taken, +you may receive further followup emails. + +## Timeline of the process + +OS2product on level 2 and above have a steering group, coordinating group and 1 or more vendors of which all members must response in the event of security issues. Information can at all times be found on the wiki pages either on Github or on [OS2s website](https://os2.eu). + +1. The recipients of the report first validate if there is indeed a (possible) issue. + +2. After validation, we confirm that we received the report and if it is indeed a valid issue. + +3. We have a private forum accessible to the technical staff. In this + forum, an issue is created for the vulnerability where the impact and possible + solutions are discussed. + +4. The next step is to create a (draft) Github security advisory, which is only visible + to the repository administrators and development group. Severity and impact + will be established here. + +5. If appropriate, we request a [`CVE identifier`](https://cve.mitre.org/cve/identifiers/) from Github. + +6. A patch is implemented, reviewed and tested in a private fork. + +7. During the patch development process, known service providers are contacted to + inform them of the vulnerability and coordinate the release date and rollout of the + fix. + +8. When the fix is tested and release coordination is done, the fix is merged into the + primary repository. The security advisory and release are published. Service providers + update their managed instances. + +9. The release and security vulnerability are communicated to the community. This + includes a message to the [`mailing list`](https://os2.eu/) and announcements on the choosen communication platform. \ No newline at end of file