GitHub: короткий огляд для новачків

 

Розробники програм використовують у роботі різні платформи для обміну вихідним кодом, його зберігання та розповсюдження. Однією з таких платформ є GitHub. Вона настільки популярна, що її потужності мають навіть такі «монстри», як Microsoft і RedHat. Інструментарій платформи включає можливості перегляду коду, а також його розповсюдження з документацією та релізами.

Веб-сервіс GitHub затребуваний для хостингу IT-проектів та спільної розробки. Розробники системи називають її "соціальною мережею" для програмістів. Тут вони об'єднують репозиторії, коментують приклади «чужого» коду та використовують платформу як хмарне сховище з можливістю швидкої передачі замовнику.

Создание аккаунта в Github

Перший крок до використання сервісу GitHub полягає у реєстрації нового користувача. У процедурі немає нічого складного – достатньо зайти на офіційний сайт https://github.com/ та створити новий обліковий запис. Система запросить електронну пошту.

Пароль вводиться на вибір користувача, але з урахуванням правил. Так, рекомендується комбінація розміром 15 символів або 8, але з використанням хоча б однієї цифри і малої літери. Ім'я користувача, як і email, перевіряється на зайнятість і доведеться вибирати той, з яким платформа дозволить продовжувати реєстрацію.

Далі потрібно вказати, чи хочеться отримувати новини про оновлення продуктів та саму систему. Останнім кроком стає підтвердження – користувачеві пропонується зібрати паззл, після чого активною стане кнопка «Зареєструватися».

Вхід на платформу буде відкритий лише після підтвердження електронної пошти, тому зайти анонімно не вдасться. Це своєрідний захист сервера від численних ботів та гарантія для користувачів, що вони спілкуватимуться з реальними людьми. Тепер можна починати керувати налаштуваннями всередині особистого кабінету.

Ком'юніті тепер у Телеграм

Підпишіться та будьте в курсі останніх IT-новостей

Підписатися

Створення репозиторію

Важливо відзначити, що сервіс англомовний, і користуватися ним без знання мови вийде лише при використанні оновлених версій браузерів типу Google Chrome, де є вбудовані функції перекладу сторінок. У будь-якому разі робота починається зі створення власного репозиторію – у безкоштовному режимі доступні публічні, приватні відкриються лише за активації платного тарифу.

Послідовність дій:

1. Натиснути кнопку «Start a project».
2. Ввести назву та опис репозиторію.
3. Поставить галочку на «Initialize this repository with a README».
4. Вибрати потрібний тип ліцензії та натиснути кнопку «Create project».

Тип ліцензії (приватна або публічна) допускається замінити після використання платформи. Єдине налаштування, яке користувачі роблять відразу, - це створення кількох гілок для розміщення різних проектів. Наприклад, для тестового коду та фінальних релізів, щоб не плутати їх при розробці та спілкуванні з іншими кодерами.

Подібний підхід часто використовують творці продуктів, якими користуються маси. Їм передається посилання на перевірені стабільні версії, тоді як команда продовжує роботу над таким же комплектом файлів без побоювання порушити функціональність системи загалом. У разі використання платформи слід орієнтуватися на позначку «Branch».

Ця позначка позначає поточну гілку. Створення нової ініціюється просто – досить у списку почати набирати ще неіснуючу назву, і система видасть повідомлення Create branch. Відразу після цього користувач перекидається в нову гілку (це варто враховувати під час роботи, щоб випадково не розпочати редагування «не тих файлів»).

Зміна файлів та коміти

Коригування файлів на GitHub виконується за допомогою коммітів. Це безпосередньо саме виправлення та короткий опис змін. Такий підхід дозволяє «зовнішнім» користувачам орієнтуватися в нововведеннях коду і спрощує контроль командної роботи, коли той самий файл може редагуватися різними виконавцями.

Система збереження інформації про коригування зручна, коли вони вносяться до різних ділянок коду, але пов'язані з певним завданням. Фактично текстовий файл із описом «пов'язує» розрізнені зміни і пояснює непосвяченому програмісту їхню суть, призначення. Щоб запустити редагування README, потрібно в правій панелі натиснути на «пензлик».

Після цього відкриється текстовий редактор, де вносяться виправлення. По завершенні заповнюється поле Commit внизу сторінки (коротко, що змінилося) і натискається кнопка Commit changes. Збережені коригування будуть внесені до поточної (активної) галузі проекту, тому перед їх внесенням слід переконатися у правильному виборі.

Створення запитів злиття (Pull Request) у Github

При підключенні до роботи сторонніх фахівців може знадобитися функція запиту злиття (Pull Request). Інструмент для роботи у такому форматі називається DIFF. Він наголошує на будь-яких «чужих» змінах, щоб власник програми відразу бачив, де код писав не він. Позначки будуть доступні лише після створення комміту.

Послідовність дій:

1. Відкрийте вкладку «Pull Request».
2. Натиснути кнопку «Create Pull Request».
3. Вибрати гілку, яку слід злити з основної.
4. Переглянути внесені кодером зміни.

Після вивчення інформації створений запит злиття підтверджується натисканням «Merge Pull Request». Новий код буде імпортований в основну гілку, а створена стороннім виконавцем може спокійно видалятися.

Звіти про помилки

Платформа GitHub використовується не тільки для спільної розробки, а й для отримання зворотного зв'язку з користувачами продуктів. Так, на вкладці Issue будь-який тестувальник може залишити повідомлення про проблеми, з якими йому довелося зіткнутися при використанні ПЗ. Щоб це зробити, потрібно натиснути кнопку «New issue».

Після цього вноситься заголовок та текст повідомлення. "Проблема" відправляється натисканням на кнопку "Create new issue". Власник гілки отримує повідомлення в особистому кабінеті або на електронну пошту, вказану під час реєстрації.

Висновок

Фіналом розробки зазвичай стає випуск певного релізу програмного продукту. Це відображається на вкладці "Releases". Тут слід натиснути кнопку «Create New Release», вказати номер версії в полі «Tag Version», внести її назву та невеликий опис. Тут же прикріплюються архіви із компільованими файлами.

Залишається натиснути на Create Release і переконатися в публікації релізу. Посилання на вихідний код у tar.gz та zip створюються автоматично. Інші файли потрібно додавати вручну.

GitHub: a quick overview for beginners

By Anton Traskovsky 

timeweb.com

5 min

August 16, 2021

View Original

Software developers use various platforms to share, store, and distribute source code. One such platform is GitHub. It is so popular that even such “monsters” as Microsoft and RedHat use its power. The platform toolkit includes the ability to review the code, as well as distribute it with documentation and releases.

The GitHub web service is in demand for hosting IT projects and joint development. The developers of the system call it a "social network" for programmers. Here they merge repositories, comment on examples of “foreign” code and use the platform as a cloud storage with the ability to quickly transfer to the customer.

Creating a Github account

The first step to using the GitHub service is to register a new user. There is nothing complicated in the procedure - just go to the official website https://github.com/ and create a new account. The system will request a work email.

The password is entered at the user's choice, but subject to the rules. So, a combination of 15 characters is recommended, or 8, but using at least one number and a lowercase letter. The username, like email, is checked for employment, and you will have to choose the one with which the platform will allow you to continue registration.

Next, you need to specify whether you want to receive news about updates to products and the system itself. The final step is confirmation - the user is prompted to complete the puzzle, after which the "Register" button will become active.

The entrance to the platform will be opened only after confirmation of the email, so you will not be able to log in anonymously. This is a kind of server protection from numerous bots and a guarantee for users that they will communicate with real people. Now you can start managing settings inside your personal account.

Community is now in Telegram

Subscribe and stay up to date with the latest IT news

Subscribe

Creating a repository

It is important to note that the service is in English, and you can use it without knowing the language only when using updated versions of browsers such as Google Chrome, which have built-in functions for translating pages. In any case, work begins with creating your own repository - public ones are available in free mode, private ones will open only when a paid plan is activated.

Sequencing:

1. Click on the "Start a project" button.
2. Enter a name and description for the repository.
3. Check "Initialize this repository with a README".
4. Select the required license type and click on the "Create project" button.

The type of license (private or public) can be changed later, in the process of using the platform. The only setup users do right away is to create multiple branches to host different projects. For example, for test code and final releases, so as not to confuse them when developing and communicating with other coders.

This approach is often used by the creators of products that are used by the “masses”. They are given a link to the tested stable versions, while the team continues to work on the same set of files without fear of breaking the functionality of the system as a whole. When using the platform, you should focus on the “Branch” mark.

This mark indicates the current branch. The creation of a new one is initiated simply - just start typing a non-existent name in the list, and the system will display the message “Create branch”. Immediately after that, the user is transferred to a new branch (this should be taken into account when working so as not to accidentally start editing the “wrong files”).

File changes and commits

Correcting files on GitHub is done using commits. This is the fix itself and a brief description of the changes. This approach allows "external" users to navigate the innovations of the code and simplifies the control of team work, when the same file can be edited by different performers.

The system for saving information about adjustments is convenient when they are made to different parts of the code, but are associated with a specific task. In fact, a text file with a description “links” disparate changes and explains to an uninitiated programmer their essence and purpose. To start editing the README, you need to click on the “brush” in the right panel.

After that, a text editor will open where corrections are made. Upon completion, the “Commit” field at the bottom of the page is filled in (briefly, what has changed) and the “Commit changes” button is pressed. The saved adjustments will be made to the current (active) branch of the project, so before making them, you should make sure that the correct selection is made.

Creating Pull Requests on Github

When connecting to the work of third-party specialists, the Pull Request function may be required. The tool for working in this format is called DIFF. It underlines any “foreign” changes so that the owner of the program can immediately see where the code was not written by him. Markups will only be available after a commit has been created.

Sequencing:

1. Open the "Pull Request" tab.
2. Click on the "Create Pull Request" button.
3. Select the branch to be merged into the main branch.
4. View changes made by the encoder.

After examining the information, the created pull request is confirmed by clicking "Merge Pull Request". The new code will be imported into the main branch, and the one created by a third party can be safely deleted.

Bug reports

The GitHub platform is used not only for collaborative development, but also for getting feedback from product users. So, on the “Issue” tab, any “tester” can leave a message about the problems that he had to face when using the software. To do this, you need to click the "New issue" button.

After that, the title and text of the message are entered. An "Issue" is submitted by clicking on the "Create new issue" button. The owner of the branch receives notifications in his personal account or to the e-mail specified during registration.

Conclusion

The end of development is usually the release of a particular release of the software product. This is reflected in the Releases tab. Here you should click on the "Create New Release" button, specify the version number in the "Tag Version" field, enter its name and a short description. Archives with compiled files are also attached here.

It remains to click on "Create Release" and make sure the release is published. Links to the source code in tar.gz and zip are created automatically. Other files will need to be added manually.

Просмотры: