Skip to content

Commit

Permalink
chore: remove symlinks for md
Browse files Browse the repository at this point in the history
  • Loading branch information
yarastqt committed Jan 3, 2020
1 parent 40c48e7 commit 349cedd
Show file tree
Hide file tree
Showing 16 changed files with 131 additions and 702 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md

This file was deleted.

77 changes: 77 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Contributing

Bem React Core is an open source library that is under active development and is also used within [Yandex](https://yandex.com/company/).

All work on Bem React Core is done directly on GitHub. Members of the core group as well other participants send [Pull Requests](https://github.com/bem/bem-react-core/pulls) that go through the same verification process.

Development is carried out in branches. The main branch is `master`. The code in the `master`branch has been tested and is recommended for use.

To make changes:

1. [Create an issue](#creating-an-issue)
2. [Send your Pull Request](#sending-a-pull-request)

## Creating an issue

If you found a bug or want to make an improvement in the API:

1. First check whether the same issue already exists in the [list of issues](https://github.com/bem/bem-react-core/issues).
2. If you don't find the issue there, [create a new one](https://github.com/bem/bem-react-core/issues/new) including a description of the problem.

> **Note:** Languages other than English are not normally used in issue descriptions.
## Sending a Pull Request

To make changes to the library:

1. Fork the repository.
2. Clone the fork.

```bash
$ git clone [email protected]:<username>/bem-react-core.git
```

3. Add the main repository for the `bem-react-core` library as a remote repository with the name "upstream".

```bash
$ cd bem-react-core
$ git remote add upstream [email protected]:bem/bem-react-core.git
```

4. Fetch the latest changes.

```bash
$ git fetch upstream
```

> **Note:** Repeat this step before every change you make, to be sure that you are working with code that contains the latest updates.

5. Create a `feature-branch` that includes the number of the [created issue](#creating-an-issue).

```bash
$ git checkout upstream/master
$ git checkout -b issue-<issue number>
```

6. Make changes.
7. Record the changes made by making comments in accordance with [Conventional Commits](https://conventionalcommits.org).

```bash
$ git commit -m "<type>[optional scope]: <description>"
```

8. Fetch the latest changes.

```bash
$ git pull --rebase upstream master
```

9. Send the changes to GitHub.

```bash
$ git push -u origin issue-<issue number>
```

10. Send a [Pull Request](https://github.com/bem/bem-react-core/compare) based on the branch created.
11. Link the Pull Request and issue (for example, with a comment).
12. Wait for a decision about accepting the changes.
1 change: 0 additions & 1 deletion CONTRIBUTING.ru.md

This file was deleted.

58 changes: 27 additions & 31 deletions docs/en/LICENSE.txt → LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Mozilla Public License, version 2.0
thereof.

1.5. "Incompatible With Secondary Licenses"
means
means

a. that the initial Contributor has attached the notice described in
Exhibit B to the Covered Software; or
Expand Down Expand Up @@ -93,7 +93,6 @@ Mozilla Public License, version 2.0
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
Expand Down Expand Up @@ -163,7 +162,6 @@ Mozilla Public License, version 2.0
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
Expand Down Expand Up @@ -240,30 +238,30 @@ Mozilla Public License, version 2.0
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.
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.
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.
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

Expand All @@ -275,7 +273,7 @@ Mozilla Public License, version 2.0
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
part of this License. No use of any Covered Software is authorized under
this License except under this disclaimer.

7. Limitation of Liability
Expand Down Expand Up @@ -312,8 +310,7 @@ Mozilla Public License, version 2.0
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) Versions of the License

10.1. New Versions

Expand All @@ -338,10 +335,10 @@ Mozilla Public License, version 2.0
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.
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

Expand All @@ -365,5 +362,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
With Secondary Licenses", as defined by
the Mozilla Public License, v. 2.0.


A copy of the MPL is also available at http://mozilla.org/MPL/2.0/.
1 change: 0 additions & 1 deletion LICENSE.ru.txt

This file was deleted.

1 change: 0 additions & 1 deletion LICENSE.txt

This file was deleted.

1 change: 0 additions & 1 deletion README.md

This file was deleted.

27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Bem React

A set of tools for developing user interfaces using the [BEM methodology](https://en.bem.info) in [React](https://github.com/facebook/react). BEM React supports TypeScript and Flow type annotations.

## Packages

| Package | Version | Size |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`@bem-react/classname`](packages/classname) | [![npm (scoped)](https://img.shields.io/npm/v/@bem-react/classname.svg)](https://www.npmjs.com/package/@bem-react/classname) | [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@bem-react/classname.svg)](https://bundlephobia.com/result?p=@bem-react/classname) |
| [`@bem-react/classnames`](packages/classnames) | [![npm (scoped)](https://img.shields.io/npm/v/@bem-react/classnames.svg)](https://www.npmjs.com/package/@bem-react/classnames) | [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@bem-react/classnames.svg)](https://bundlephobia.com/result?p=@bem-react/classnames) |
| [`@bem-react/core`](packages/core) | [![npm (scoped)](https://img.shields.io/npm/v/@bem-react/core.svg)](https://www.npmjs.com/package/@bem-react/core) | [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@bem-react/core.svg)](https://bundlephobia.com/result?p=@bem-react/core) |
| [`@bem-react/di`](packages/di) | [![npm (scoped)](https://img.shields.io/npm/v/@bem-react/di.svg)](https://www.npmjs.com/package/@bem-react/di) | [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@bem-react/di.svg)](https://bundlephobia.com/result?p=@bem-react/di) |
| [`@bem-react/eslint-plugin`](packages/eslint-plugin) | [![npm (scoped)](https://img.shields.io/npm/v/@bem-react/eslint-plugin.svg)](https://www.npmjs.com/package/@bem-react/eslint-plugin) ||

## Contribute

Bem React Core is an open source library that is under active development and is also used within [Yandex](https://yandex.com/company/).

If you have suggestions for improving the API, you can send us a [Pull Request](https://github.com/bem/bem-react-core/pulls).

If you found a bug, you can create an [issue](https://github.com/bem/bem-react-core/issues) describing the problem.

For a detailed guide to making suggestions, see: [CONTRIBUTING.md](docs/en/CONTRIBUTING.md).

## License

© 2018 [Yandex](https://yandex.com/company/). Code released under [Mozilla Public License 2.0](LICENSE.txt).
1 change: 0 additions & 1 deletion README.ru.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/LANGS.md

This file was deleted.

77 changes: 0 additions & 77 deletions docs/en/CONTRIBUTING.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/en/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/en/book.json

This file was deleted.

Loading

0 comments on commit 349cedd

Please sign in to comment.