Прошел целый год с тех пор, как я внес свой первый вклад в программное обеспечение с открытым исходным кодом, и это заставило меня задуматься о том, что делает отличный репо начинающий.
В отличном начинающем репо -репо необходимо легко внести свой вклад, но все же часть реального продукта. Важно по -прежнему чувствовать удовлетворение от обогащения сообщества с открытым исходным кодом. Это должен быть производственный код, но проект должен быть простым в создании, и использовать автоматизацию, где это возможно. Что -то вроде серии сложных команд терминала может быть резким для новичка!
Кроме того, я полагаю, что начинающие должны ожидать, что они будут проверять свой код, а также написать чистый, поддерживаемый код. Они фундаментальны для участия в открытом исходном коде, верно? Это может быть сложнее на некоторых языках, чем другие. Например, модульное тестирование в C ++ общеизвестно.
Наконец, я думаю, что отличные репо начинающих требуют знаний от участника, то есть вы не хотите выполнять работу, которые никто не хочет делать. Вы хотите ввести некоторые из ваших собственных идей в проект. Это может быть трудно, когда вам не хватает опыта и опыта.
Суть в том, что я сделал репо, который, я думаю, удается сделать все эти вещи.
Габриэльбаркер/Qual-Id
Restful API, который возвращает случайно сгенерированные, пользовательские качественные идентификаторы. Все взносы приветствуются. Бесполезно!
Restful API, который возвращает случайно сгенерированные, пользовательские качественные удостоверения личности
Используя API • Вклад • Лицензия
Qual Id – это RESTFUL API, который возвращается Качественный идентификатор Анкет A Качественный идентификатор это уникальное значение, которое читается и понятно для людей. Это служит той же цели, что и любой другой идентификатор, а также гораздо приятнее, и гораздо легче запомнить.
Используя API
Доступ к API REST Qual ID можно получить с помощью URL -адреса
https://qual-id.herokuapp.com/
Конечная точка «категории»
Конечная точка «категории» возвращает список категорий, которые можно составить для создания шаблоны Принят конечной точкой «получить». Например:
https://qual-id.herokuapp.com/categories/
который вернет объект JSON, содержащий список имен категорий, например,
{ "data": ["animal", "food"] }Образцы идентификатора квалификации
Приемлемый шаблон для конечной точки «получить» – это любой список UP…
Это называется Qual Id. Это API REST, написанный на Python, используя колбу, которая служит Качественный идентификатор в качестве альтернативы сгенерированным нечитаемым идентификаторам. Доступ к остальным API можно получить Здесь , или для активного примера, Здесь Анкет
Вклад входит в форму Добавление новых значений в определенные категории Т.е. Добавление «яблока, манго, груши» в список значений в категории фруктов. Или добавить новую категорию вместе!
Как только пиар объединяется, приложение автоматически развернуто с Heroku, поэтому участник может видеть, как их код работает в прямом эфире за считанные минуты, просто посетив URL.
Важно отметить, что участники пишут настоящий код Python, который будет фактически запустить на сервере Анкет
Я думаю, что то, что делает этот репо таким веселым, это то, что он требует творчества, но имеет низкие ставки и мало ограничений.
Это также обеспечивает хороший первый опыт PR, так как участники могут увидеть CI/CD и модульный тестирование GitHub, и насколько они полезны.
Я надеюсь, что люди увидят это репо и сделают решающий шаг, чтобы сделать пиар. Создание моего первого пиара было настолько освобождающим, и очень приятно помочь другим сделать то же самое!
Счастливого взлома
Оригинал: “https://dev.to/gabrielbarker/great-python-beginner-repo-qual-id-3jmg”