Добро пожаловать! ??
Good First Issue — это инициатива по подбору простых вариантов из популярных проектов, чтобы разработчики, которые никогда не участвовали в разработке открытого исходного кода, могли быстро приступить к работе.
Специалисты по сопровождению открытого исходного кода всегда стремятся привлечь к участию больше людей, но новые разработчики обычно считают, что стать соавтором сложно. Мы считаем, что если разработчикам придется решать очень простые проблемы, это устранит барьер для дальнейшего участия. Вот почему существует Good First Issue.
Вы можете добавить новый проект в Good First Issue, и мы поощряем все проекты — старые и новые, большие и маленькие.
Выполните следующие простые шаги:
Наша цель — сузить число проектов для новых участников с открытым исходным кодом. Чтобы поддерживать качество проектов в Good First Issue, убедитесь, что ваш репозиторий GitHub соответствует следующим критериям:
У него есть как минимум три выпуска с good first issue
. Эта метка уже присутствует во всех репозиториях по умолчанию. Если нет, вы можете выполнить следующие действия здесь.
У него есть как минимум 10 участников.
Он содержит README.md с подробными инструкциями по настройке проекта и CONTRIBUTING.md с рекомендациями для новых участников.
Он активно поддерживается.
Добавьте путь к вашему репозиторию (в лексикографическом порядке) в data/repositories.toml.
Создайте новый пул-реквест. Пожалуйста, добавьте ссылку на страницу проблем репозитория в описание PR. Как только запрос на включение будет объединен, изменения появятся на сайте Goodfirstissue.dev.
Good First Issue состоит из двух компонентов — внешнего приложения, созданного с помощью Nuxt.js, и сценария заполнения данных, написанного на Python.
Чтобы внести новые функции и изменения на веб-сайт, вам необходимо запустить приложение локально. Пожалуйста, выполните следующие действия:
Клонируйте проект локально. Убедитесь, что на вашем компьютере установлены Python 3 и последняя версия Node.js.
Сделайте копию примеров файлов данных для использования вашим локальным приложением и переименуйте их в имя файла, ожидаемое приложением. Этот шаг важен, поскольку интерфейсное приложение не будет работать без этих файлов данных.
$ cp data/generated.sample.json data/generated.json $ cp data/tags.sample.json data/tags.json
Создайте интерфейсное приложение и запустите сервер разработки.
$ Bun install # установка зависимостей$ Bun dev # запуск сервера разработки
Приложение должно открыться в вашем браузере.