groldsf_obsidian_check_plugin/docs/contributing.md

40 lines
2.1 KiB
Markdown
Raw Normal View History

2025-05-03 02:41:24 +00:00
---
title: Contributing
nav_order: 6
2025-05-03 02:41:24 +00:00
---
2025-05-03 01:13:22 +00:00
# Contributing
- [English](#english)
- [Русский](#русский)
## English
If you want to make changes or improvements to the plugin:
1. **Fork** the repository.
2. **Clone** your fork locally.
3. **Install dependencies:** `npm install` (or yarn)
4. **Start development build:** `npm run dev` (or yarn dev)
5. Create a new branch: `git checkout -b feature/feature-name`
6. Make changes and commit: `git commit -m "feat: Description of changes"` (Try to follow [conventional commit messages](https://www.conventionalcommits.org/))
7. Push changes to your fork: `git push origin feature/feature-name`
8. Open a Pull Request in the original repository.
Please ensure your code adheres to the existing style and include updates to the documentation (`/docs`) if your changes affect usage or settings.
---
## Русский
Если вы хотите внести изменения или улучшения в плагин:
1. **Форкните** репозиторий.
2. **Клонируйте** ваш форк локально.
3. **Установите зависимости:** `npm install` (или yarn)
4. **Запустите сборку для разработки:** `npm run dev` (или yarn dev)
5. Создайте новую ветку: `git checkout -b feature/имя-функционала`
6. Внесите изменения и сделайте коммит: `git commit -m "feat: Описание изменений"` (Старайтесь следовать [conventional commit messages](https://www.conventionalcommits.org/))
7. Отправьте изменения в свой форк: `git push origin feature/имя-функционала`
8. Откройте Pull Request в оригинальном репозитории.
Пожалуйста, убедитесь, что ваш код соответствует существующему стилю, и включите обновления документации (`/docs`), если ваши изменения затрагивают использование или настройки.