diff --git a/CHANGES.md b/CHANGES.md index 4d3b3aef9e1..01d35d7bb55 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,8 +1,8 @@ CKEditor 5 Changelog -==================== +======================================== -## CKEditor 5.0.0 (DEV) +## CKEditor 5.0.0 -**First Release** - Build Date: yyyy-mm-dd +**First Release** – Build Date: yyyy-mm-dd TODO: For the first release, we will not list new features or changes but more specifically describe CKEditor 5, emphasizing its differences and relation with CKEditor 4. In few words though, just like one would expect a changelog file to be. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 135bfc5b282..46711aa3de8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,55 +1,41 @@ Contributing -============ +======================================== ## Fixing Issues / Coding Features It is all about software, so the most optimal way to contribute is by coding. -Infrastructure and a well defined workflow is in place to handle code contributions, based on GitHub Pull Requests:
-[https://github.com/ckeditor/ckeditor5/pulls](https://github.com/ckeditor/ckeditor5/pulls) +Infrastructure and a well defined workflow is in place to handle code contributions, based on GitHub Pull Requests: [https://github.com/ckeditor/ckeditor5/pulls](https://github.com/ckeditor/ckeditor5/pulls). Things to keep in mind: - * We expect contributions to follow the [high-quality code standards that we follow](https://github.com/ckeditor/ckeditor5-design/wiki#coding), - including coding style and tests. Lack of attention to this point may either make it slow to adopt a contribution or - even force us to reject it altogether. - - * There is no guarantee that your contribution will be incorporated in the main code. Still pull requests make it easy - for you to keep them for your own use or for others which may be interested on them. - - * Having a CLA is essential to have your contributions accepted (see bellow). +* We expect contributions to follow the [high-quality code standards that we follow](https://github.com/ckeditor/ckeditor5-design/wiki#coding), including coding style and tests. Lack of attention to this point may either make it slow to adopt a contribution or even force us to reject it altogether. +* There is no guarantee that your contribution will be incorporated in the main code. Still pull requests make it easy for you to keep them for your own use or for others which may be interested on them. +* Having a CLA is essential to have your contributions accepted (see bellow). ## Translating Being this a project with global impact, contributing translations is both an easy and powerful way to help. -We use the Transifex service for translations at the following address:
-[https://www.transifex.com/projects/p/ckeditor/](https://www.transifex.com/projects/p/ckeditor/) +We use the Transifex service for translations at the following address: [https://www.transifex.com/projects/p/ckeditor/](https://www.transifex.com/projects/p/ckeditor/). Here as well, having a CLA in place is a requirement to become an official translator (see bellow). ## Reporting Issues / Requesting Features -The easiest way to contribute is by simply reporting issues that you find in our project. We use the following GitHub -page to track and manage them:
-[https://github.com/ckeditor/ckeditor5/issues](https://github.com/ckeditor/ckeditor5/issues) +The easiest way to contribute is by simply reporting issues that you find in our project. We use the following GitHub page to track and manage them: [https://github.com/ckeditor/ckeditor5/issues](https://github.com/ckeditor/ckeditor5/issues). Things to keep in mind: - * Search for existing issues before starting a new one. This helps our team to have the backlog in order. - * Be concise and informative, making it easy for our team to understand the problem. - * Do not use the issues pages for asking for help. - * Feel free to jump into discussions around issues, exposing your opinion. +* Search for existing issues before starting a new one. This helps our team to have the backlog in order. +* Be concise and informative, making it easy for our team to understand the problem. +* Do not use the issues pages for asking for help. +* Feel free to jump into discussions around issues, exposing your opinion. The issues pages can be used for feature requests. - ## Contributor License Agreement (CLA) -To accept contributions sent to us in form of code, documentation or translations, a Contributor License Agreement (CLA) -must be in place in order to clarify the intellectual property license granted with them. This license is for your -protection as a contributor as well as the protection of us and our users; it does not change your rights to use your -own contributions for any other purpose. +To accept contributions sent to us in form of code, documentation or translations, a Contributor License Agreement (CLA) must be in place in order to clarify the intellectual property license granted with them. This license is for your protection as a contributor as well as the protection of us and our users; it does not change your rights to use your own contributions for any other purpose. -To sign the CLA and to have more information, please follow this link:
-[http://ckeditor.com/cla](http://ckeditor.com/cla) +To sign the CLA and to have more information, please follow this link: [http://ckeditor.com/cla](http://ckeditor.com/cla). diff --git a/LICENSE.md b/LICENSE.md index 23f9417b866..841d9d38afd 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,31 +1,23 @@ Software License Agreement ========================== -**CKEditor 5** - https://github.com/ckeditor/ckeditor5
-Copyright (c) 2003-2014, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. +**CKEditor 5** – https://github.com/ckeditor/ckeditor5
+Copyright (c) 2003-2016, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. Licensed under the terms of any of the following licenses at your choice: - * [GNU General Public License Version 2 or later (the "GPL")](http://www.gnu.org/licenses/gpl.html) +* [GNU General Public License Version 2 or later (the "GPL")](http://www.gnu.org/licenses/gpl.html) +* [GNU Lesser General Public License Version 2.1 or later (the "LGPL")](http://www.gnu.org/licenses/lgpl.html) +* [Mozilla Public License Version 1.1 or later (the "MPL")](http://www.mozilla.org/MPL/MPL-1.1.html) - * [GNU Lesser General Public License Version 2.1 or later (the "LGPL")](http://www.gnu.org/licenses/lgpl.html) - - * [Mozilla Public License Version 1.1 or later (the "MPL")](http://www.mozilla.org/MPL/MPL-1.1.html) - -You are not required to, but if you want to explicitly declare the license you have chosen to be bound to when using, -reproducing, modifying and distributing this software, just include a text file titled "legal.txt" in your version of -this software, indicating your license choice. In any case, your choice will not restrict any recipient of your version -of this software to use, reproduce, modify and distribute this software under any of the above licenses. +You are not required to, but if you want to explicitly declare the license you have chosen to be bound to when using, reproducing, modifying and distributing this software, just include a text file titled "legal.txt" in your version of this software, indicating your license choice. In any case, your choice will not restrict any recipient of your version of this software to use, reproduce, modify and distribute this software under any of the above licenses. Sources of Intellectual Property Included in CKEditor ----------------------------------------------------- -Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned -intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource -with their express permission. +Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission. Trademarks ---------- -**CKEditor** is a trademark of [CKSource](http://cksource.com) Frederico Knabben. All other brand and product names are -trademarks, registered trademarks or service marks of their respective holders. +**CKEditor** is a trademark of [CKSource](http://cksource.com) Frederico Knabben. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders. diff --git a/dev/tasks/dev/templates/CHANGES.md b/dev/tasks/dev/templates/CHANGES.md index 95b0ca7be62..70ee18e0fa3 100644 --- a/dev/tasks/dev/templates/CHANGES.md +++ b/dev/tasks/dev/templates/CHANGES.md @@ -1,2 +1,25 @@ -Changelog -==================== +{{AppName}} Changelog +======================================== + +## {{AppName}} 0.0.2 + +**Major|Minor|Patch Release** - Build Date: yyyy-mm-dd + +New Features: + +* [#Issue Number](http://issue/url): Item 1. +* Item 2 + +Fixed Issues: + +* [#Issue Number](http://issue/url): Item 1. +* Item 2 + +Other Changes: + +* Item 1 +* Item 2 + +## {{AppName}} 0.0.1 + +... diff --git a/dev/tasks/dev/templates/CONTRIBUTING.md b/dev/tasks/dev/templates/CONTRIBUTING.md index 5a1988f1db7..aefc066d140 100644 --- a/dev/tasks/dev/templates/CONTRIBUTING.md +++ b/dev/tasks/dev/templates/CONTRIBUTING.md @@ -1,2 +1,4 @@ Contributing -============ +======================================== + +Information about contributing can be found at the following page: . diff --git a/dev/tasks/dev/templates/LICENSE.md b/dev/tasks/dev/templates/LICENSE.md index 23f9417b866..d11f6501121 100644 --- a/dev/tasks/dev/templates/LICENSE.md +++ b/dev/tasks/dev/templates/LICENSE.md @@ -1,31 +1,23 @@ Software License Agreement ========================== -**CKEditor 5** - https://github.com/ckeditor/ckeditor5
-Copyright (c) 2003-2014, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. +**{{AppName}}** – https://github.com/ckeditor/ckeditor5
+Copyright (c) 2003-2016, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. Licensed under the terms of any of the following licenses at your choice: - * [GNU General Public License Version 2 or later (the "GPL")](http://www.gnu.org/licenses/gpl.html) +* [GNU General Public License Version 2 or later (the "GPL")](http://www.gnu.org/licenses/gpl.html) +* [GNU Lesser General Public License Version 2.1 or later (the "LGPL")](http://www.gnu.org/licenses/lgpl.html) +* [Mozilla Public License Version 1.1 or later (the "MPL")](http://www.mozilla.org/MPL/MPL-1.1.html) - * [GNU Lesser General Public License Version 2.1 or later (the "LGPL")](http://www.gnu.org/licenses/lgpl.html) - - * [Mozilla Public License Version 1.1 or later (the "MPL")](http://www.mozilla.org/MPL/MPL-1.1.html) - -You are not required to, but if you want to explicitly declare the license you have chosen to be bound to when using, -reproducing, modifying and distributing this software, just include a text file titled "legal.txt" in your version of -this software, indicating your license choice. In any case, your choice will not restrict any recipient of your version -of this software to use, reproduce, modify and distribute this software under any of the above licenses. +You are not required to, but if you want to explicitly declare the license you have chosen to be bound to when using, reproducing, modifying and distributing this software, just include a text file titled "legal.txt" in your version of this software, indicating your license choice. In any case, your choice will not restrict any recipient of your version of this software to use, reproduce, modify and distribute this software under any of the above licenses. Sources of Intellectual Property Included in CKEditor ----------------------------------------------------- -Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned -intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource -with their express permission. +Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission. Trademarks ---------- -**CKEditor** is a trademark of [CKSource](http://cksource.com) Frederico Knabben. All other brand and product names are -trademarks, registered trademarks or service marks of their respective holders. +**CKEditor** is a trademark of [CKSource](http://cksource.com) Frederico Knabben. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders. diff --git a/dev/tasks/dev/templates/README.md b/dev/tasks/dev/templates/README.md index 836c6d489f3..fbc9c2d5323 100644 --- a/dev/tasks/dev/templates/README.md +++ b/dev/tasks/dev/templates/README.md @@ -1,2 +1,10 @@ -Development Repository -=================================== +{{AppName}} +======================================== + +[![devDependency Status](https://david-dm.org/{{GitHubRepositoryPath}}/dev-status.svg)](https://david-dm.org/{{GitHubRepositoryPath}}#info=devDependencies) + +The core framework of CKEditor 5 project. More information about the project can be found at the following url: . + +## License + +Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file.