Skip to content

Commit

Permalink
Merge pull request #86 from ckeditor/t/42
Browse files Browse the repository at this point in the history
Fixed formatting in existing MD files and created templates for new p…
  • Loading branch information
Reinmar committed Feb 18, 2016
2 parents 4b54ae5 + 39adab7 commit 7ab82e5
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 67 deletions.
6 changes: 3 additions & 3 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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.
40 changes: 13 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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: <br>
[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: <br>
[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: <br>
[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: <br>
[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).
24 changes: 8 additions & 16 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
Software License Agreement
==========================

**CKEditor 5** - https://github.com/ckeditor/ckeditor5 <br>
Copyright (c) 2003-2014, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
**CKEditor 5** https://github.com/ckeditor/ckeditor5 <br>
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.
27 changes: 25 additions & 2 deletions dev/tasks/dev/templates/CHANGES.md
Original file line number Diff line number Diff line change
@@ -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

...
4 changes: 3 additions & 1 deletion dev/tasks/dev/templates/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
Contributing
============
========================================

Information about contributing can be found at the following page: <https://github.com/ckeditor/ckeditor5/blob/master/CONTRIBUTING.md>.
24 changes: 8 additions & 16 deletions dev/tasks/dev/templates/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
Software License Agreement
==========================

**CKEditor 5** - https://github.com/ckeditor/ckeditor5 <br>
Copyright (c) 2003-2014, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
**{{AppName}}** https://github.com/ckeditor/ckeditor5 <br>
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.
12 changes: 10 additions & 2 deletions dev/tasks/dev/templates/README.md
Original file line number Diff line number Diff line change
@@ -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: <https://github.com/{{GitHubRepositoryPath}}>.

## License

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file.

0 comments on commit 7ab82e5

Please sign in to comment.