JavaRush /Java блог /Random /Кофе-брейк #43. 6 ошибок в программировании, которые меша...

Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом

Статья из группы Random

6 ошибок в программировании, которые мешают получить работу мечты

Источник: Medium Чтобы найти работу программиста, вам необходимо иметь Git-репозиторий. Это одна из первых вещей, на которую будут обращать внимание рекрутеры. Чтобы ваш репозиторий произвел положительное впечатление, в нем должны находиться проекты с недавно внесенными изменениями. Показывайте только те проекты, которыми вы гордитесь, а не каждую строку кода, которую вы когда-либо писали. Это основы работы с репозиторием. Помните, что рано или поздно кто-то обязательно изучит ваш код, чтобы проверить, подходите ли вы для компании. Для вас это станет решающим моментом. Спустя несколько минут рекрутер решит, стоит ли приглашать вас на собеседование. И вот здесь есть как хорошие новости, так и плохие.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 1Плохая новость заключается в том, что простая ошибка может снизить ваши шансы на получение работы. Хорошая новость в том, что люди обычно не хотят глубоко изучать код. Им нужно общее понимание вашего кода и архитектуры. Так что вам не обязательно быть гениальным — вам достаточно быть хорошим программистом. Вот несколько распространенных ошибок, которые делают новички. Избегайте их, и ваши шансы на собеседовании резко возрастут.

Устаревшие комментарии

У программистов разные мнения о комментариях. Одни любят их, другие ненавидят. Мы не можем прийти к единому выводу о том, стоит ли комментировать код и в каких случаях это делать. Но все единодушны в одном: если у вас есть комментарии, они должны соответствовать вашему коду. Комментарии существуют для пояснения кода. Когда у вас сложный или непонятный код, читателям нужно помочь понять его. Также вам нужно менять свой комментарий при изменении кода. Если вы этого не сделаете, ваш комментарий перестанет быть полезным. Плохой комментарий намного хуже, чем его отсутствие. Что еще хуже, комментарии выделяются в коде. Современные IDE выделяют комментарии другим цветом, чтобы они легко читались. Добавляя комментарий, вы помещаете в код знак «прочти меня». Таким образом, любое расхождение между комментарием и кодом будет легко обнаружено. Выбирайте комментарии обдуманно и не забывайте обновлять их вместе с кодом. Так они сослужат вам хорошую службу.

Сочетание библиотек и языков с одинаковыми сценариями использования

Перед первым собеседованием мне нужно было решить задачу по подбору персонала. Это было простое веб-приложение, поэтому я написал код, поискал ответы на несколько сложных вопросов в Google, и приложение было готово. На собеседовании рекрутер спросил меня, почему я смешал код jQuery с простым JavaScript во всем коде. Мой ответ? «Эмм…» По правде говоря, я вставил несколько фрагментов кода из Stack Overflow. Я особо не задумывался об этом. Код сработал, поэтому я двинулся дальше. Эта ошибка очень распространена среди начинающих разработчиков. Мы настолько сосредоточены на решении проблем в работе, что не уделяем внимания тому, каким способом мы это делаем. Не становитесь одним из новичков, попавших в эту ловушку. Изучите каждую строку кода и убедитесь, что вы знаете, зачем вы ее туда поместили.

Повторение кода

Не повторяйся (Don’t Repeat Yourself — DRY) — это догма программирования. Создание абстракций для повторяющегося кода — это суть программирования. Да, вначале может быть сложно. Когда вы хотите решить проблему, вы делаете это любым возможным способом. Затем вы переходите к другим задачам, и повторяющийся код остается с вами. Избавиться от подобной привычки можно, создав для себя набор правил. Каждый раз, когда вы дорабатываете функцию, прочтите код еще раз и подумайте, есть ли возможность что-то изменить. Помните, что первая версия кода, как правило, ошибочна, и вы можете ее улучшить. Когда вы заметили у себя повторяющийся код, выделите время на его изучение. Так вы сможете найти наилучший способ, как его можно переписать (например, используя цикл или создав новую функцию). Если вы будете делать такую чистку каждый раз, то получите более надежный и элегантный код.

Необработанные ошибки

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

Отсутствие последовательности

Последовательность — отличительная черта качественного программного обеспечения. Она упрощает чтение и обслуживание кода. Код, созданный в едином стиле, более предсказуем, и по нему легче оценивать работу программы. На более высоком уровне абстракции добиться согласованности сложно. Чтобы овладеть ею, потребуются годы, поэтому начинать изучение этой методики нужно как можно раньше. Не забывайте создавать названия, используя только один язык. Вероятно, это должен быть английский, но в личных проектах вы можете называть переменные и функции на любом языке, если это всегда один и тот же язык. Если вы последовательны, то неважно, используете ли вы табуляцию или пробелы. Создайте или выберите руководство по стилю и всегда придерживайтесь его. Вам также следует использовать такой инструмент, как Prettier. Он очень помогает придерживаться форматирования кода по единому образу. Какие бы инструменты и стили вы ни использовали, применяйте их постоянно. Даже если вы пишете плохой код в едином стиле, это обычно лучше, чем непоследовательно хороший код, так как его гораздо легче исправить.

Непонимание инструментов

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

Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом

Источник: Jamestucker.dev На днях я увидел твит Эвана Ю (создателя Vue.js) о новом репозитории, над которым он работал, и меня это заинтересовало. Я решил, что хочу внести в него свой вклад! Загвоздка в том, что раньше я никогда не участвовал в проектах с открытым исходным кодом и не знал, с чего начать. Но ведь это не может быть так сложно, правда? Попав в репозиторий, я тут же замер. «Что, черт возьми, мне делать?», — подумал я про себя.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 2Если я сделаю PR (пулл реквест, запрос на слияние), специалисты, вероятно, разнесут мой код в клочья. Я всегда буду известен в мире разработки как парень, который не умеет работать с open source должным образом. И моя карьера закончится. К счастью, я прочитал статью (уже не помню где), автор которой советовал, чтобы ваш первый вклад в чужой репозиторий был максимально сдержанным. Это может быть что-то простое, например, исправление опечатки. И я так и сделал. Я прочитал документацию репозитория, нашел несколько опечаток, открыл PR — и о чудо, Эван утвердил мои изменения. Я официально стал соавтором Vue! Может, мне стоит поместить это в свою биографию в Твиттере?

«Это здорово, но как я могу начать?»

Хорошо, давайте начнем: я покажу вам шаги, которые вы можете предпринять, чтобы внести свой вклад.

1. Найдите проект

Для вдохновения подумайте о своей любимой технологии или инструменте. Скажем, вы работаете с JavaScript часто используете Gatsby? Посмотрите их репозиторий! Вы также можете внести свой вклад в один из моих репозиториев. Тут есть список моих фронтенд-проектов. Если у вас есть что-то, что вы любите или считаете полезным, я бы хотел, чтобы вы это добавили! И, наконец, Awesome First PR Opportunities — это гигантский репозиторий проектов с открытым исходным кодом для начинающих. Есть проекты на 22 разных языках!

2. Определитесь с тем, какой вы можете сделать вклад

Ознакомьтесь с проектом. Прочитайте Readme. Просканируйте разные папки и файлы. Получите представление о структуре кодовой базы. Выполнив это, вы сможете легко найти и исправить опечатку! Как только вы это сделаете, взгляните на раздел «Проблемы» в проекте. Там вы найдете список ранее найденных ошибок или предлагаемых функций. К счастью, многие проекты связаны с проблемами, которые ориентированы на новичков. Я считаю, что ваш первый вклад должен быть как можно более незаметным, но если вы хотите быстро завоевать признание, то решать вам. Как только вы найдете что-то, что можете добавить в проект, вам нужно будет создать его форк.

3. Создание форка проекта

Форк (разветвление проекта) создает его точную копию в вашем собственном репозитории Github.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 3

4. Клонируйте проект локально

Затем клонируйте проект в локальную папку, используя URL-адрес проекта.

git clone <project-url>
Здесь вы найдете URL-адрес.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 4Теперь, когда проект находится на вашем компьютере, откройте его в редакторе. Если вы считаете, что на внесение изменений потребуется время, обязательно синхронизируйте копию проекта с оригиналом, чтобы вы всегда были в курсе изменений. Вы можете найти точные команды Git для этого здесь.

5. Создайте новую ветку для ваших изменений

Пришло время внести свои изменения / исправления! Создайте новую ветку, в которой будут действовать ваши изменения.

git branch <branch-name>
Вы можете назвать ее как хотите, но по моему опыту вы сможете увидеть шаблон для именования веток в исходном проекте. В таком случае рекомендую следовать существующему шаблону. Хорошим названием ветки для исправления опечатки было бы patch/typo-fix. Вы можете переключиться на эту ветку с помощью git checkout <branch-name>. А теперь внесите свои изменения!

6. Откройте PR (запрос на слияние)

Итак, вы исправили вопиющую опечатку или обновили неработающую ссылку. Вы гордитесь своей работой. Вы хотите, чтобы весь мир знал, что вы один из тех мифических разработчиков, которые могут программировать, стирать и смотреть Netflix одновременно. Отправляйте свои изменения в разветвленный репозиторий Github с помощью git push -u origin <branch-name>. Перейдите в свой разветвленный репозиторий Github и откройте PR (запрос на слияние). Примечание: если вы никогда раньше не делали пул-реквест, посмотрите это видео Кента Доддса, чтобы узнать, как это сделать.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 5Убедитесь, что ваша ветка указывает на основную ветку исходного репозитория.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 6Теперь вы готовы добавить детали к своему PR. Убедитесь, что ваш заголовок четко передает содержание PR. Добавьте описание: если вы исправляете существующую проблему, обязательно укажите ссылку на нее.Кофе-брейк #43. 6 ошибок в программировании, которые мешают получить работу мечты. Как впервые внести свой вклад в разработку программного обеспечения с открытым исходным кодом - 7Как только вы закончите со своим описанием, отправьте PR на рассмотрение. Тот, кто наделен полномочиями утверждать PR, скорее всего, рассмотрит вашу заявку в течение нескольких дней и сделает одно из следующих действий:
  1. Немедленно объединит изменения.
  2. Попросит внести изменения.
  3. Закроет ваш PR.
Будьте терпеливы, так как создатель репозитория может быть занят работой на полную ставку или другими проектами.

Вы сделали это!

Теперь вы участник проекта с открытым исходным кодом! Каково это? Готовы создать своего собственного конкурента Node.js? Я надеюсь, что, сделав простой вклад, перспективы будущей работы над open source станут менее пугающими. Для получения дополнительной информации о вкладе в open source ознакомьтесь с руководствами по открытым исходным кодам.
Комментарии (3)
ЧТОБЫ ПОСМОТРЕТЬ ВСЕ КОММЕНТАРИИ ИЛИ ОСТАВИТЬ КОММЕНТАРИЙ,
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ
Денис Уровень 16
26 сентября 2020
статья топ
Юрий Уровень 31
24 сентября 2020
Не совсем понял, я делаю Pull Reuest внутри своего репозитария, и что дальше? Как отправить мой PR на удалённый репозитарий автора(то есть в его репозитраий) или мне надо отправить автору ссылку на свой репозитарий???