Руководство по внесению вклада

Введение

Прежде всего, спасибо за то, что рассматриваете возможность внести вклад в graphin! Именно такие люди, как вы, делают сообщество открытого исходного кода таким замечательным местом для обучения, вдохновения и творчества. Этот документ содержит рекомендации по внесению вклада в graphin. Пожалуйста, уважайте эти рекомендации, чтобы поддерживать совместную и инклюзивную среду.

Способы внесения вклада

Существует множество способов внести вклад в graphin:

• Сообщение об ошибках: Если вы обнаружили ошибку, пожалуйста, проверьте систему отслеживания проблем, чтобы узнать, была ли она уже сообщена. Если нет, создайте новую проблему. Обязательно укажите ясный заголовок, подробное описание и как можно больше релевантной информации.
• Предложение улучшений: Новые идеи всегда приветствуются. Создайте проблему, чтобы предложить улучшения или новые функции.
• Написание документации: Хорошая документация так же важна, как и сам код. Если вам нравится писать и вы хотите помочь, рассмотрите возможность улучшения документации.
• Отправка запросов на вытягивание: Запросы на вытягивание необходимы нам, чтобы продолжать двигаться вперёд. Будь то исправление ошибки, реализация функции или улучшение документации, каждый вклад ценен.

Начало работы

Перед тем как начать вносить вклад, убедитесь, что:

1. Вы создали форк репозитория и создали свою ветку из v3.
2. Если вы добавляете код, добавьте тесты, которые покрывают новую функциональность/исправление ошибки.
3. Убедитесь, что тестовый набор проходит локально.
4. Если вы изменили API, обновите документацию.
5. Убедитесь, что ваш код соответствует стандартам линтинга.
6. Напишите чёткое сообщение журнала для ваших коммитов. Однострочные сообщения подходят для небольших изменений, но более крупные изменения должны включать больше деталей.

Процесс запроса на вытягивание

1. Убедитесь, что ваш код следует соглашениям о кодировании проекта (отступ, точные комментарии и т. д.) и что все ваши коммиты подписаны.
2. Обновите README.md любыми изменениями, которые важны для проекта.
3. Увеличьте номера версий в любых файлах примеров и README.md до новой версии, которую будет представлять этот запрос на вытягивание.
4. Вы можете объединить запрос на вытягивание, как только получите одобрение двух других разработчиков, или если у вас нет разрешения сделать это, вы можете попросить второго рецензента объединить его за вас.

Как запустить проект

• Установка зависимостей:

$ pnpm install

• Отладчик с живой демонстрацией:

$ cd packages/graphin

$ npm run dev

• Запуск тестовых случаев и сборка:

$ cd packages/graphin

$ npm run build