CONTRIBUTING.md

Contributing

Bem React Core is an open source library that is under active development and is also used within Yandex.

All work on Bem React Core is done directly on GitHub. Members of the core group as well other participants send Pull Requests that go through the same verification process.

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

To make changes:

1. Create an issue
2. Send your 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.
2. If you don't find the issue there, create a new one 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.

   $ git clone git@github.com:<username>/bem-react-core.git

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

   $ cd bem-react-core
   $ git remote add upstream git@github.com:bem/bem-react-core.git

4. Fetch the latest changes.

   $ 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.

   $ 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.

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

8. Fetch the latest changes.

   $ git pull --rebase upstream master

9. Send the changes to GitHub.

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

10. Send a Pull Request 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.