Skip to content

Commit

Permalink
Merge branch 'master' into i/6453
Browse files Browse the repository at this point in the history
  • Loading branch information
niegowski committed May 7, 2020
2 parents 34139c7 + c9e2754 commit f86fd8b
Show file tree
Hide file tree
Showing 462 changed files with 1,613 additions and 6,959 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ A set of ready-to-use rich text editors created with a powerful framework. Made

![CKEditor 5 Classic rich text editor build screenshot](https://c.cksource.com/a/1/img/npm/ckeditor5-build-classic.png)

## ⚠ This package does not contain any source code

CKEditor 5 is distributed as [several ready-to-use rich text editor builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#available-builds) which you can [install from npm](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installation.html#npm).

You can also [customize the existing builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/development/custom-builds.html) or build your own editors and features by using the [CKEditor 5 Framework](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/overview.html).

## Table of contents

* [Quick start](#quick-start)
Expand Down Expand Up @@ -113,11 +107,11 @@ For a high-level overview of the project see the [CKEditor Ecosystem website](ht

### Ideas and discussions

The main development repository of CKEditor 5 is located at [https://github.com/ckeditor/ckeditor5](https://github.com/ckeditor/ckeditor5). This is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback and will be much appreciated!
The development repository of CKEditor 5 is located at [https://github.com/ckeditor/ckeditor5](https://github.com/ckeditor/ckeditor5). This is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback and will be much appreciated!

### Development

CKEditor 5 is a modular, multi-package, multi-repository project. It consists of several packages that create the editing framework, based on which the feature packages are implemented.
CKEditor 5 is a modular, multi-package, [monorepo](https://en.wikipedia.org/wiki/Monorepo) project. It consists of several packages that create the editing framework, based on which the feature packages are implemented.

The [ckeditor5](https://github.com/ckeditor/ckeditor5) repository is the place that centralizes the development of CKEditor 5. It bundles different packages into a single place, adding the necessary helper tools for the development workflow, like the builder and the test runner. [Basic information on how to set up the development environment](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/development-environment.html) can be found in the documentation.

Expand Down
2 changes: 0 additions & 2 deletions docs/builds/guides/support/getting-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ order: 30

You can report issues and feature requests on [GitHub](https://github.com/ckeditor/ckeditor5). This is also a good place to discuss architecture decisions and things which are not yet covered by the documentation.

[Each CKEditor 5 repository](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=) handles its issues independently. If you are not sure where your ticket belongs, it is best to report it in the [main repository](https://github.com/ckeditor/ckeditor5).

Refer to {@link builds/guides/support/reporting-issues Reporting issues} guide for more details.

## Stack Overflow
Expand Down
7 changes: 6 additions & 1 deletion docs/builds/guides/support/reporting-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@ Most of the issues are reproducible on the demo. If you have a different case th

## Reporting issues

All issues should be reported in the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5/issues) on GitHub.
All issues should be reported in the [CKEditor 5 repository](https://github.com/ckeditor/ckeditor5/issues) on GitHub, except ones that are related to one of the following projects (which have their own issue pages):

* [Angular integration](https://github.com/ckeditor/ckeditor5-angular),
* [React integration](https://github.com/ckeditor/ckeditor5-react),
* [Vue integration](https://github.com/ckeditor/ckeditor5-vue),
* [CKEditor 5 inspector](https://github.com/ckeditor/ckeditor5-inspector).

Things to keep in mind:

Expand Down
24 changes: 12 additions & 12 deletions docs/framework/guides/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,25 @@ Read more about our {@link framework/guides/contributing/testing-environment tes
GitHub provides an [excellent documentation about pull requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/). If you are not sure what to do, this is the right place to start.
</info-box>

Assuming that you would like to propose some changes in the [Link](https://github.com/ckeditor/ckeditor5-link) feature, these are the steps you should take to create a pull request:
<info-box>
[Angular](https://github.com/ckeditor/ckeditor5-angular), [React](https://github.com/ckeditor/ckeditor5-react) and [Vue](https://github.com/ckeditor/ckeditor5-vue) integrations as well as [CKEditor 5 inspector](https://github.com/ckeditor/ckeditor5-inspector) and [dev packages](https://github.com/ckeditor/ckeditor5-dev) are kept in separate repositories. The below steps assume that you want to propose a change in the [main CKEditor 5 repository](https://github.com/ckeditor/ckeditor5).
</info-box>

Assuming that you would like to propose some changes, these are the steps you should take to create a pull request:

1. Make sure to open a ticket describing the issue/feature/problem that you want to solve in your pull request. This can be skipped in case of obvious and trivial changes (typos, documentation, etc.). You can report this ticket in the specific repository in which you will make a pull request or in https://github.com/ckeditor/ckeditor5.
1. Make sure to open a ticket in https://github.com/ckeditor/ckeditor5 describing the issue/feature/problem that you want to solve in your pull request. This can be skipped in case of obvious and trivial changes (typos, documentation, etc.).
1. Make sure your {@link framework/guides/contributing/development-environment development environment} is ready.
1. Go to GitHub and [fork the repository](https://help.github.com/articles/fork-a-repo) ([ckeditor5-link](https://github.com/ckeditor/ckeditor5-link) in this particular case). The forked repository will appear in your GitHub account as `https://github.com/YOUR-USERNAME/ckeditor5-link`.
1. Go to GitHub and [fork the repository](https://help.github.com/articles/fork-a-repo). The forked repository will appear in your GitHub account as `https://github.com/YOUR-USERNAME/ckeditor5`.
1. Open your terminal, then go to the package ("repository") folder in your development environment:

```shell
$ cd path/to/ckeditor5/packages/ckeditor5-link
$ cd path/to/ckeditor5
```

1. Start a new branch for your code. We use the `t/GITHUB-ISSUE-NUMBER` convention for branch names:
1. Start a new branch for your code. We use the `i/GITHUB-ISSUE-NUMBER` convention for branch names:

```shell
$ git checkout -b t/GITHUB-ISSUE-NUMBER
$ git checkout -b i/GITHUB-ISSUE-NUMBER
```

1. Make the changes. Stick to the [code-style guidelines](#code-style) and remember about [tests and 100% code coverage](#tests)!
Expand All @@ -68,13 +72,13 @@ Assuming that you would like to propose some changes in the [Link](https://githu
1. Now it is time to make your changes public. First, you need to let `git` know about the fork you created by adding the remote:

```shell
$ git remote add my-fork https://github.com/YOUR-USERNAME/ckeditor5-link
$ git remote add my-fork https://github.com/YOUR-USERNAME/ckeditor5
```

1. Push your changes to your forked repository:

```shell
$ git push my-fork t/GITHUB-ISSUE-NUMBER
$ git push my-fork i/GITHUB-ISSUE-NUMBER
```

1. Go to your forked repository on GitHub. Use the [pull request button](https://help.github.com/articles/about-pull-requests/) and follow the instructions. Make sure to include a merge commit message text matches the {@link framework/guides/contributing/git-commit-message-convention convention}
Expand All @@ -86,10 +90,6 @@ Some additional things you should keep in mind:
* When making a pull request on GitHub, make sure to specify which ticket(s) your pull request resolves. It is also recommended to provide more information, like how to test the patch, issues that you encountered, decisions you had to make, known problems, etc.
* Make sure you signed the [Contributor License Agreement (CLA)](#contributor-license-agreement-cla) and that tests pass. Test your changes!

<info-box>
If want your changes to be permanent in your development environment, make sure your `mrgit.json` file {@link framework/guides/contributing/development-environment#using-mrgit-for-custom-packages points to your forked version of the repository} so next time you execute `mrgit sync` to refresh the project, the utility will use your fork.
</info-box>

## Translating

CKEditor 5 is a project with global impact, so contributing translations is both an easy and powerful way to help.
Expand Down
Loading

0 comments on commit f86fd8b

Please sign in to comment.