Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (68 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

87 lines (68 loc) · 3.92 KB

CONTRIBUTING.md (Engl)

Thank you for your interest in our project! We are glad that you want to contribute. Please read these guidelines before you begin.

How to Contribute

  1. Fork the repository: Click the "Fork" button in the upper right corner of the repository page to create your own copy.

  2. Clone the repository: Clone your fork to your local machine:

git clone https://github.com/Stervar/your_repository.git
  1. Create a new branch: Before you commit changes, create a new branch:
git checkout -b your_branch_name

  1. Make changes: Make the necessary changes to the code.

  2. Add and commit your changes:

git add .
git commit -m "Describe your changes"
  1. Push your changes to your fork:
git push origin your_branch_name
  1. Create a Pull Request: Go to your fork's GitHub page and click the "Compare & pull request" button.

Style Guidelines

  • Please follow the project's coding style.
  • Add comments to your code if necessary.
  • Update documentation if your changes affect functionality.

Reporting Bugs

If you find a bug, please create a new issue in the repository, describing the problem in as much detail as possible. Provide information on how to reproduce the error and, if possible, provide a solution.

License

Your changes will be subject to the project's license. Please see the LICENSE file for more information.

CONTRIBUTING.md (RU)

Спасибо за интерес к нашему проекту! Мы рады, что вы хотите внести свой вклад. Пожалуйста, ознакомьтесь с этими рекомендациями, прежде чем начать.

Как внести вклад

  1. Форкните репозиторий: Нажмите на кнопку "Fork" в правом верхнем углу страницы репозитория, чтобы создать свою копию.

  2. Клонируйте репозиторий: Склонируйте свой форк на локальную машину:

    git clone https://github.com/Stervar/ваш_репозиторий.git

  3. Создайте новую ветку: Перед тем как внести изменения, создайте новую ветку:

    git checkout -b имя_вашей_ветки

  4. Внесите изменения: Внесите необходимые изменения в код.

  5. Добавьте и закоммитьте изменения:

    git add .
git commit -m "Описание ваших изменений"

  6. Отправьте изменения в ваш форк:

    git push origin имя_вашей_ветки

  7. Создайте Pull Request: Перейдите на страницу вашего форка на GitHub и нажмите на кнопку "Compare & pull request".

Правила оформления

  • Пожалуйста, следуйте стилю кода, принятому в проекте.
  • Добавляйте комментарии к коду, если это необходимо.
  • Обновляйте документацию, если ваши изменения затрагивают функциональность.

Сообщение об ошибках

Если вы нашли ошибку, пожалуйста, создайте новый issue в репозитории, описав проблему как можно подробнее. Укажите, как воспроизвести ошибку, и, если возможно, предложите решение.

Лицензия

Ваши изменения будут подчиняться лицензии проекта. Пожалуйста, ознакомьтесь с файлом LICENSE для получения дополнительной информации.