Как найти проекты на github

Как найти проекты на github

Правильный поиск по GitHub поможет вам найти нужного разработчика или нужный репозиторий с кодом. GitHub — это один из тех сервисов, которые не нужно представлять людям, хоть немного связанным с программированием. Это ресурс, на котором каждый программист просто обязан иметь аккаунт, потому что большинство современных компаний, прежде чем нанимать к себе разработчика, проверяют его профиль на GitHub. Если в профиле «есть что посмотреть» и на самом ресурсе программист проявлял активность, то это приносит ему много плюсов в резюме.

На сегодняшний день на GitHub зарегистрировано более 35 миллионов аккаунтов, поэтому поиск нужного программиста именно по этому сервису более чем оправдан. Плюс ко всему GitHub — это огромная площадка, где разработчики размещают код своих работающих приложений, которые распространяются по свободной лицензии. То есть GitHub — это огромное хранилище исходников, поэтому поиск нужного кода или репозитория по этому ресурсу тоже более чем оправдан.

 

Поиск кода или разработчика по GitHub

Искать разработчика или нужный код можно разными путями. Например, разработчиков можно искать на специализированных сайтах по поиску работы, таких как hh.ru. Когда нужен код, можно воспользоваться специальным форумом или попросить помощи у других программистов. Но и в том и в другом случае очень правильно будет вести поиск по GitHub, ведь это один их тех ресурсов, где сконцентрированы лучшие программистские умы.

 

Поиск кода или репозитория по GitHub

Поиск нужного кода по GitHub может пригодиться в разных ситуациях. Если же вам нужен исходный код какой-либо программы, то, возможно, вам нужно искать его не на самом GitHub, а на официальном сайте той же программы, если она, конечно, распространяется с открытым исходным кодом. Обычно программы с открытыми исходниками сами оставляют ссылки на свои архивы.

Если же у вас другая ситуация, то можно воспользоваться внутренним поиском самого GitHub. Первым делом вам нужно будет позаботиться о наличии аккаунта на данной площадке, чтобы вы могли искать по всем доступным репозиториям. Когда вам нужно осуществить поиск по всему GitHub, то необходимо воспользоваться глобальной поисковой строкой на самой площадке. Если вы знаете, репозитории какой организации вы хотите найти, то можно осуществить поиск по GitHub внутри конкретной организации.

Поиск репозитория можно выполнить по следующим идентификаторам:

  • in:name — поиск по имени репозитория, то есть искомые слова будут искаться в наименовании репозиториев;

  • in:description — поиск по описанию репозитория на совпадение указанных слов поиска именно в описании;

  • in:readme — поиск по файлам README;

  • repo:owner/name — поиск по точному совпадению имени репозитория.

Также можно осуществить поиск нужного репозитория по GitHub:

  • по размеру репозитория;

  • по количеству подписчиков;

  • по количеству вилок;

  • по количеству звезд;

  • по дате создания;

  • по дате последнего обновления;

  • по используемому языку программирования;

  • по теме;

  • по количеству тем;

  • по лицензии;

  • по видимости репозитория;

  • по наличию проблем с репозиторием;

  • по возможности оказать спонсорскую помощь;

  • и др.

Как видите, вариантов поиска нужного репозитория по GitHub очень много, поэтому вы обязательно сможете найти то, что ищите.

 

Поиск разработчиков по GitHub

Итак, мы условились, что GitHub — это специализированный ресурс для разработчиков разного уровня, поэтому искать там нужного программиста — это нормально. Здесь работает такой же принцип, как и с поиском репозиториев, — нужно обязательно быть зарегистрированным на GitHub, иначе найти нужного разработчика не получится.

Как только зарегистрируетесь, вам станет доступно множество вариантов поиска нужного разработчика. Важно отметить, что некоторые способы поиска идентичны поиску репозиториев, и именно их изначально вам выдаст GitHub. Чтобы искать именно разработчиков, переключите результаты поиска на категорию «Users». 

Среди всех популярных вариантов поиска разработчиков отметим следующие:

  1. Поиск по ключевым словам. К примеру, если вам необходим python-разработчик, то введите в поиске слово «python».

  2. Поиск по языкам программирования, которыми должен обладать искомый разработчик. Введите в поисковой строке любой язык программирования, и GitHub выдаст вам результат.

  3. Поиск по технологиям. Работает так же, как и с языками программирования: просто введите название необходимого фреймворка, который не является самостоятельным языком программирования.

  4. Искать по активности программиста. Обычно этот вид поиска осуществляют, когда уже нашли список потенциальных кандидатов, допустим, по языку программирования. Далее в качестве фильтра можно отсеять тех, кто давно не проявлял активность на GitHub.

Программист на GitHub не всегда заинтересован в поиске новой работы — нужно помнить об этом. Второй момент: не все программисты на GitHub те, за кого себя выдают, поэтому важно с потенциальными кандидатами познакомиться и побеседовать лично, чтобы можно было поподробнее расспросить о скиллах, которыми обладает найденный разработчик. Ведь на GitHubработает принцип любой соцсети — написать о себе можно много чего, также можно в своих репозиториях держать совсем не свой код и т. д.

 

Заключение

Поиск нужного кода или разработчика по GitHub — это логичное действие, потому что подобных специализированных площадок для программистов не так много. Вернее, они есть, но они не такого уровня, как GitHub.

С поиском кода вроде все ясно, поэтому сложностей возникнуть не должно. Тем более раз вы ищите код, то вы в нем как минимум разбираетесь. Сложнее с поиском разработчиков, потому что на GitHub очень много «пустышек», которые просто будут отнимать у вас время.

Источник

If your code is stored locally on your computer and is tracked by Git or not tracked by any version control system (VCS), you can import the code to GitHub using GitHub CLI or Git commands.

About adding existing source code to GitHub

If you have source code stored locally on your computer that is tracked by Git or not tracked by any version control system (VCS), you can add the code to GitHub by typing commands in a terminal. You can do this by typing Git commands directly, or by using GitHub CLI.

GitHub CLI is an open source tool for using GitHub from your computer’s command line. GitHub CLI can simplify the process of adding an existing project to GitHub using the command line. To learn more about GitHub CLI, see “About GitHub CLI.”

If your source code is tracked by a different VCS, such as Mercurial, Subversion, or Team Foundation Version Control, you must convert the repository to Git before you can add the project to GitHub.

  • “Importing a Subversion repository”
  • “Importing a Mercurial repository”
  • “Importing a Team Foundation Version Control repository”

Warning: Never git add, commit, or push sensitive information to a remote repository. Sensitive information can include, but is not limited to:

  • Passwords
  • SSH keys
  • AWS access keys
  • API keys
  • Credit card numbers
  • PIN numbers

For more information, see “Removing sensitive data from a repository.”

Initializing a Git repository

If your locally-hosted code isn’t tracked by any VCS, the first step is to initialize a Git repository. If your project is already tracked by Git, skip to “Importing a Git repository with the command line.”

  1. Open TerminalTerminalGit Bash.

  2. Navigate to the root directory of your project.

  3. Initialize the local directory as a Git repository. By default, the initial branch is called main.

    If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using -b.

    git init -b main

    If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using git symbolic-ref.

    git init && git symbolic-ref HEAD refs/heads/main

  4. Add the files in your new local repository. This stages them for the first commit.

    $ git add .
# Adds the files in the local repository and stages them for commit. To unstage a file, use 'git reset HEAD YOUR-FILE'.

  5. Commit the files that you’ve staged in your local repository.

    $ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. To remove this commit and modify the file, use 'git reset --soft HEAD~1' and commit and add the file again.

Importing a Git repository with the command line

After you’ve initialized a Git repository, you can push the repository to GitHub, using either GitHub CLI or Git.

  • “Adding a local repository to GitHub with GitHub CLI”
  • “Adding a local repository to GitHub using Git”

Adding a local repository to GitHub with GitHub CLI

  1. To create a repository for your project on GitHub, use the gh repo create subcommand. When prompted, select Push an existing local repository to GitHub and enter the desired name for your repository. If you want your project to belong to an organization instead of your user account, specify the organization name and project name with organization-name/project-name.

  2. Follow the interactive prompts. To add the remote and push the repository, confirm yes when asked to add the remote and push the commits to the current branch.

  3. Alternatively, to skip all the prompts, supply the path to the repository with the --source flag and pass a visibility flag (--public, --private, or --internal). For example, gh repo create --source=. --public. Specify a remote with the --remote flag. To push your commits, pass the --push flag. For more information about possible arguments, see the GitHub CLI manual.

Adding a local repository to GitHub using Git

  1. Create a new repository on GitHub.com. To avoid errors, do not initialize the new repository with README, license, or gitignore files. You can add these files after your project has been pushed to GitHub. For more information, see “Creating a new repository.”
  2. At the top of your repository on GitHub.com’s Quick Setup page, click to copy the remote repository URL.
    Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.
  3. Open TerminalTerminalGit Bash.
  4. Change the current working directory to your local project.
  5. Add the URL for the remote repository where your local repository will be pushed. 
    $ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL
  6. Push the changes in your local repository to GitHub.com. 
    $ git push -u origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin

  1. Create a new repository on GitHub.com. To avoid errors, do not initialize the new repository with README, license, or gitignore files. You can add these files after your project has been pushed to GitHub. For more information, see “Creating a new repository.”

  2. At the top of your repository on GitHub.com’s Quick Setup page, click to copy the remote repository URL.

    Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.

  3. Open TerminalTerminalGit Bash.

  4. Change the current working directory to your local project.

  5. In the Command prompt, add the URL for the remote repository where your local repository will be pushed.

    $ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL

  6. Push the changes in your local repository to GitHub.com.

    $ git push origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin

  1. Create a new repository on GitHub.com. To avoid errors, do not initialize the new repository with README, license, or gitignore files. You can add these files after your project has been pushed to GitHub. For more information, see “Creating a new repository.”

  2. At the top of your repository on GitHub.com’s Quick Setup page, click to copy the remote repository URL.

    Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.

  3. Open TerminalTerminalGit Bash.

  4. Change the current working directory to your local project.

  5. Add the URL for the remote repository where your local repository will be pushed.

    $ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL

  6. Push the changes in your local repository to GitHub.com.

    $ git push origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin

Further reading

  • “Adding a file to a repository”
Источник

Делаете работу
В процессе находите ошибку в стороннем коде
Находите ее источник
Пишите багрепорт и тесткей
Так как всем пофиг
Сами фиксите баг
Неделю стучитесь мейнтейнеру, чтоб он принял ваш пушреквест
Он вас посылает, тк ето не баг

Находите гитхаб репозиторий понравившейся вам библиотеки, заходите в issues, там часто бывают метки “good for a first PR”, “good first issue” и т.д., короче для новичков, форкаете проект, разрешаете ишью, коммитите, прочитав contribution.md в репозитории, делаете PR, отписываетесь в ишью и ждёте пока его примут/подпросят подкорректировать.
Готово!

  1. Форкаете чужой проект
  2. Кодите у себя
  3. Делаете Pull Request

Пулл-Реквест должен быть хорошо оформлен: обязан соблюдаться код-стайл проекта даже если он вам не очень нравится, и ваш П.Р. должен иметь исчерпывающее описание и т.п.;

На каждый баг/фичу использовать отдельный пулл-реквест, не стоит пытаться пропихнуть всю работу за один раз.

Находить проекты просто, либо на самом ГитХабе, либо в футерах делают ссылки на свои репозитории.

Есть три генеральных варианта.
1) участвовать в крупных проектах с контрибьюторами, правилами и всем таким прочим 1а) закрывать issue s 1b) фигачить новый функционал (это сложнее)
2) участвовать в маленьких проектах где 1-2 контрибьютора, но на проект есть спрос со стороны сообщества. Скажем, openssl в свое время почти в 1 каску разрабатывался и тестировался, хотя использовался много кем.
3) участвовать в маленьких проектах, сделанных just for fun. Это может быть не так круто, как п.1 и п.2, но зато у вас там будет гораздо больше возможностей, а если не получится прийти к договоренности с автором – всегда можно форкнуть и пилить так, как хочется лично вам.
Проектов куча 1 и 2, начиная от фреймворков и инструментов, до библиотек и утилит. Кроме того, есть десятки тысяч just for fun проектов, это игры и тому подобная ерундистика.
Отсортировал варианты по убыванию сложности и по убыванию важности. Первое и второе можно упоминать в резюме (а-ля контрибутил в Linux Kernel), проекты третьего типа – нежелательно)

Источник

Нажмите выше “Школа программирования“, выберите как”Установить звезду”

Качественные изделия с доставкой немедленно!

Автор:Juefei

juejin.im/post/5e3d01c56fb9a07c91100801

У многих мелких партнеров часто возникает такая путаница. Я прочитал много технических учебных документов, книг и даже видео. Я хочу попрактиковаться, поэтому я открыл GitHub и хотел найти проект с открытым исходным кодом, чтобы изучить и получить практический опыт в этом проекте. . В это время многие мелкие партнеры столкнутся с проблемой: «Я не могу искать, как мне это найти?», И в конце концов сможет только сдаться.

Я считаю, что прочитав эту статью, вы сможете узнать, как точно искать проекты на GitHub.

  Компонент проекта с открытым исходным кодом

Прежде чем прояснить ситуацию, давайте сначала разберемся, каковы компоненты проекта с открытым исходным кодом:

  • name: название проекта

  • description: краткое описание проекта

  • Исходный код проекта

  • README.md: Знакомство с деталями проекта

В дополнение к этим элементам, количество звезд и ответвлений самого проекта также является критерием для оценки популярности проекта с открытым исходным кодом, а также очень важным критерием поиска. Кроме того, мы также должны обратить внимание на дату последнего обновления этого проекта, потому что чем активнее проект, тем чаще он будет обновляться.

Вышеупомянутые элементы – это некоторые из ключевых моментов, на которые следует обращать внимание при поиске.

  Как искать

Так как же искать?

Предположим, мы хотим найти React сейчас, я считаю, что большинство мелких партнеров напрямую вводят в поле поиска: «React», а затем нажимают Enter, вы обнаружите, что ситуация выглядит следующим образом:

Результаты поиска покажут много проектов с открытым исходным кодом, из-за чего вы ошеломлены и не сможете начать. Многие друзья сдались после поиска на этом этапе, потому что проектов слишком много, и они не могут найти, как найти проекты с открытым исходным кодом, которые их интересуют. Поиск очень неточный. Итак, давайте изучим чуть более точный метод поиска.

в соответствии с name искать

Найдите проекты, которые содержат React в названии проекта:

in:name React

Получите следующие результаты:

Как видите, все эти результаты поиска – это проекты с ключевым словом React в названии проекта, но проектов по-прежнему много.

Теперь давайте ограничим

Например, я могу точно указать звездное число проекта больше 5000+:

in:name React stars:>5000

Результат такой:

Результаты поиска становятся более точными мгновенно, и теперь на выбор доступно всего 114 элементов. Конечно, мы обычно не устанавливаем количество звезд так высоко, как правило, установка 1000 почти такая же.

Таким же образом мы можем искать по количеству вилок:

in:name React stars:>5000 forks:>3000

Вы обнаружите, что результаты становятся все более точными!

в соответствии с README Искать

Найдите в README.md проекты, содержащие React:

 in:readme React

Результатов так много, поэтому давайте ограничим количество звездочек и вилок:

in:readme React stars:>3000 forks:>3000

Результаты поиска были точными сразу до 90. В этот раз вы перейдете к выбору проекта, это станет намного проще.

в соответствии с descriptin искать

Предположим, теперь мы хотим узнать о проектах микросервисов, мы ищем проекты, которые содержат микросервисы в описании проекта:

в: описание Микросервис

Результатов так много, что мы добавим несколько условий фильтрации:

в: описание Язык микросервиса: python

language: python означает, что мы ограничиваем язык питоном, посмотрим, как это получится:

Результаты поиска намного точнее.

Если в этих проектах мы хотим найти проекты, которые были обновлены недавно, то есть время обновления является самым последним, мы можем сделать это:

in: description Язык микросервиса: нажатие на python:> 2020-01-01

нажата:> 2020-01-01 означает, что мы ограничили время последнего обновления проекта до 2020-01-01, давайте посмотрим, каков результат:

Результатов поиска всего 8, и эти проекты относятся к наиболее активным, так что меня больше не запутает.

  подводить итоги

Ладно, подведем итоги. Мы хотим вести точный поиск, не более чем добавление условий фильтрации.

  1. in: name xxx // поиск по названию проекта

  2. in: readme xxx // поиск по README

  3. in: description xxx // поиск по описанию

Итак, здесь мы можем добавить условия фильтрации

  1. stars:> xxx // количество звезд больше, чем xxx

  2. forks:> 3000 // Количество вилок больше xxx

  3. language: xxx // язык программирования xxx

  4. нажато:> ГГГГ-ММ-ДД // Время последнего обновления больше, чем ГГГГ-ММ-ДД

Выше приведены несколько советов по точному поиску проектов на GitHub, надеюсь, это поможет вам!

Ответьте на "ключевые слова" ниже, чтобы получить качественные ресурсы

 Ответьте на ключевое слово "pybook03", чтобы немедленно получить электронную версию "Think Python 2e", переведенную домашней страницей и друзьями.
 Ответьте на ключевое слово "Introduction", чтобы сразу получить электронную версию 10 вводных книг по Python, собранных на домашней странице.
 Ответьте на ключевое слово "m", чтобы сразу получить подборку избранных высококачественных статей на Python.
 Ответьте на ключевое слово "номер книги", замените номер цифрой от 0 и выше, есть сюрпризы и подарки ~
 Заглавное изображение: pexels, авторизовано CC0.

 Хорошая статья, читаю
Источник

Я хочу внести свой вклад в проекты с открытым исходным кодом на Github. В основном, я бы хотел начать с исправления небольших ошибок или добавления новых функций. У меня нет конкретного проекта. Я бы хотел работать над проектами C, C ++, Python, .NET, Java и т. Д. Однако моя проблема в том, что я не могу понять, как найти что-нибудь на Github.

Я нашел страницу на Explore Github, где перечислены проекты на C. По сути, в нем перечислены 5 самых «наблюдаемых» C-проектов. ОК, хорошо, но я хочу увидеть больше 5.

Sourceforge был / хорош, потому что вы можете просматривать проекты по языку программирования. Кроме того, SourceForge имеет или имел форум для поиска проектов, которые просят о помощи. Я не могу найти ничего подобного на Github. Существует функция «Поиск», которая кажется бесполезной для поиска проектов, в которые можно внести свой вклад. Я попробовал расширенный поиск, установив его в «Репозитории» и «C» для языка программирования. Тем не менее, вы должны положить что-то в поиске; хотя я просто хочу просмотреть названия и описания проектов.

Итак, я попытался поставить «сеть», чтобы посмотреть, что произойдет. Это дает только список каждого форка каждого проекта, который есть.

Есть ли какой-нибудь способ, которым я могу искать, скажем, через третьих лиц или что-то еще, проекты в здравом уме? Кажется, у Github должна быть такая вещь; Я бы просто выбрал Sourceforge, так как я могу искать там, но я хочу создать профиль Github, так как это аромат месяца, и есть все эти фанаты на Hacker News, которые, кажется, считают, что профиль Github лучше, чем Resume. /РЕЗЮМЕ. 🙂

Практическое занятие «Поиск open-source проекта»

Чтобы проникнуть в мир API документации, нам нужно подумать о примерах API документации в нашем портфолио. Портфолио является ключом к работе технического писателя API документации. Без портфолио, содержащего убедительные примеры, будет сложно найти работу по документации API.

Избегаем “Уловки-22”

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

Обойти эту “Уловку-22” очень просто: создаем примеры документации API с помощью проектов с открытым исходным кодом, в которые мы внесли свой вклад. Вот где пригодится данное практическое занятие.

Вместо того, чтобы просто завершать модули и отслеживать свои успехи в завершении курса, выполняемые нами практические занятия помогут пополнить наш портфолио примерами документации API, помогая либо получить задание по документированию API, либо выполнить домашний запуск проект по API документации.

Поиск опен-сорс проекта с API

Если у вас уже есть проект API в вашей работе, или если вы разработчик, работающий над проектом API, просто выберите свой существующий API для курсовых работ. Однако, если вы развиваете свои навыки API документации с нуля, вам нужно найти проект документации API с открытым исходным кодом, в который вы можете внести свой вклад.

Поиск подходящего проекта может быть сложной задачей, но он важен для вашего портфолио и вашего успеха в проникновении в мир документации API. К счастью, почти все проекты с открытым исходным кодом используют GitHub, и GitHub предоставляет различные теги для документации и «help wanted» для привлечения добровольцев. (Задача настолько распространена, GitHub предоставляет советы по поиску проектов с открытым исходным кодом.)

Идеальный опен-сорс проект должен отвечать следующим критериям:

  • проект содержит API (не нативную библиотеку API или какой-либо другой инструмент разработчика, который не является API);
  • проект нуждается в документации API;
  • проект не должен быть настолько технически сложным, чтобы вы не могли его изучить. (Если вы уже знакомы с языком программирования, вы можете ориентироваться на проекты, ориентированные на этот язык.);
  • Проект должен быть активным, с недавними коммитами.

‍ Практика: Поиск проекта с необходимостью документирования API

Для поиска нужного проекта:

  1. Открываем расширенный поиск GitHub
  2. Скроллим экран и ищем раздел Issues Options. В поле With the labels вписываем help wanted . Это стандартный тег, который команды используют для привлечения добровольцев в свой проект (но некоторые команды, которым нужна помощь, могут его и не использовать). Скроллим вверх и замечаем, что надпись: «Требуется помощь» автоматически заполняется в поле Advanced Search.
  3. В поле Advanced Search добавляем ключевые слова documentation и api перед тегом help wanted
  1. Нажимаем кнопку Search и видим результат.

В полученном списке можно поискать проект REST API (а не API нативной библиотеки, такой как Java API). Есть ли проекты, которые выглядят интересными или перспективными? Если так, отлично. Если нет, добавляем ключевые слова и продолжаем искать.

  1. Если поиск на GitHub не дал подходящих проектов, можно поискать на следующих ресурсах:

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

  1. После выбора проекта пометим следующее:
  • Задействован ли REST API в проекте?
  • Как в проекте помечены проблемы, связанные с документацией? Например, используется ли в нем ярлык «документация»?
  • Определяем текущее состояние документации проекта: является ли она надежной, скудной, обширной, есть она вообще?
  • Насколько активен проект? (Какова частота коммитов?)
  • Сколько участников в проекте?

Примечание: Пока не нужно связываться или взаимодействовать с командой. Мы просто собираем информацию и анализируем потребности в документации здесь.

Понимание типа API, используемого в проекте

Во время поиска проекта API, нужно понять, что существует множество различных типов API. Многие из API-интерфейсов, с которыми мы работаем, могут быть исходными библиотеками API, которые не используют веб-протоколы для выполнения запросов и ответов (как это делают API-интерфейсы REST), а скорее подключают к проекту библиотеки для конкретного языка. Если кажется, что API фокусируется на определенном языке, а документация API выглядит автоматически, скорее всего это исходная библиотека API.

С другой стороны, если документация проекта содержит основные разделы конечных точек — это API REST.

Содействие потребует навыков работы с Git

Прежде чем вносить свой вклад в опен-сорс проект, нужно понять основной процесс Git Pull request. Для понимания рабочего процесса Git возможно придется освоить инструкции Git или вот Git на русском. Но лучший способ изучения Git, это активная практика в реальном проекте.

Не будем отвлекаться сейчас на Git. Можно будет изучить его уже на практике. Пока же просто ищем проект.

Не недооценивайте свои писательские навыки

Можно подумать, что слишком рано думать о присоединении к проекту, не говоря уже о внесении вклада в проект документации API, особенно когда мы только учимся этому. Когда мы взаимодействуем с командой разработки опен-сорс проекта, можно чувствовать страх, что нет навыков программирования. Однако не стоит недооценивать нашу роль в качестве автора документации (независимо от вклада). Проекты с открытым исходным кодом частенько сильно страдают от паршивой документации.

Неполная или устаревшая документация является распространенной проблемой, наблюдаемой 93 процентами респондентов, однако 60 процентов участников говорят, что они редко или никогда не вносят свой вклад в документацию.

Также посмотрим Open source documentation is bad, but proprietary software is worse Мэтта Асаи. Мэтт выделяет результаты документации того же опроса GitHub:

93% респондентов скрежетали зубами от некачественной документации, но также признались, что практически ничего не сделали для улучшения ситуации. … Если вы считаете, что глубокая потребность в документации побудит большее количество разработчиков внести свою лепту и помочь, вы ошибаетесь: 60% разработчиков не могут потрудиться представить документацию.

Так что, да, как технические писатели, мы не исправляем ошибки в коде и не разрабатываем новые функции, но наша роль разработчика документации все еще крайне необходима и ценится. Мы — редкие птицы в лесу разработки.

Автору курса хорошо знакомо значение роли документации из его личного опыта написания документации для опен-сорс проектов. В какой-то момент, прежде чем сосредоточить свою энергию на этом курсе по API, он написал несколько руководств для документации по Jekyll. Том Джонсон добавил инструкции, которые включали много нового контента, и даже добавил раздел Tutorials.

Предполагалось, что другие разработчики будут продолжать создавать новые руководства, но они этого не делали. Разработчики, как правило, добавляют небольшие отрывки документации к страницам — предложение здесь, абзац там, обновление здесь, исправление там. Редко можно найти кого-то, кто пишет новую статью или учебник с нуля. Когда выпускается новый выпуск, часто не появляются заметки о выпуске — это просто ссылки на (загадочные) журналы проблем GitHub.

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

Дополнительное чтение

Дополнительные материалы к изучению:

Справочник по GitHub Pull Request доступен в разделе Процесс Pull request на GitHub

“GitHub Code Search: Find more, search less” — GitHub запустил поисковой движок

“GitHub Code Search: Find more, search less” — GitHub запустил поисковой движок - 1

Всем привет, дорогие друзья! Мне как любителю новых фич на GitHub было очень интересно узнать, что скоро все мы сможем быстро и качественно искать по кодовой базе GitHub. Это может быть очень удобно, особенно в случае, если нужно найти изощренный способ использования какого-то инструмента. Особенно это резонирует с тем, что в России открыли будущего конкурента GitHub. Поэтому GitHub точно не стоит почивать на лаврах несмотря на то, что они несомненно лидеры на рынке. Нужно идти дальше и развиваться, а то не ровен час и конкуренты догонят и сметут. И пусть это не кажется таким уж невероятным. Как пример: много ли еще осталось тех, использует телефоны Nokia? Кто вообще знает, что они делали телефоны? В свое время они были просто недосягаемые, бесспорные лидеры рынка… А теперь значатся где-то в области статистической погрешности.

Первое впечатление

  • по организациям;
  • по языкам программирования;
  • по конкретному владельцу;
  • по расширению файла;
  • по регулярному выражению.

Поговорим более детально про поиск

“GitHub Code Search: Find more, search less” — GitHub запустил поисковой движок - 2

Очень интересно заглянуть и попытаться поискать самому: так ли это удобно, как об этом говорят? Пока что этой фичи нет в общем доступе и можно добавить себя в лист ожидания по ссылке. Там заполняем все пункты, вопросы простые, здесь описывать не буду. В итоге добавляемся в лист ожидания и идем дальше. В результате, будет вот такой ответ: Осталось просто ждать. Как только меня добавят, я обязательно все вам покажу. Не затягивайте, добавляйтесь, чтобы потом в первых рядах разобраться и пользоваться себе на радость) А так конечно очень жаль, что нельзя сразу же опробовать новый инструмент, поэтому разберем их документацию и опишем более детально, как мы сможем использовать этот инструмент для нашей работы. Теперь и про поиск. В нем буду использовать классы и конструкции, которые имеют смысл в библиотеке, что я пишу. Так мне будет понятней и проще, надеюсь и вам.

Источник

Добавить комментарий