first-contributions README

The project's README from github.com/firstcontributions/first-contributions. As one markdown file: README.md.

Open Source Love License: MIT Open Source Helpers

Read this in other languages.

Shqip Armenian Uzbek language Azərbaycan dili বাংলা Bulgarian Português (Brasil) Català 中文 (Simplified) Czech Deutsch Dansk المصرية Dezéiriya Español de España Française Gaeilge Galego Ελληνικά ქართული Magyar Bahasa Indonesia עִברִית ગુજરાતી / हिन्दी / मराठी / മലയാളം / ಕನ್ನಡ / తెలుగు / ଓଡିଆ / छत्तीसगढ़ी / ਪੰਜਾਬੀ/کٲشُر தமிழ் فارسی Italiano 日本語 සිංහල 한국어 Lietuvių kalba Limba Română Limba Română မြန်မာ Македонски Español de México Bahasa Melayu / بهاس ملايو‎ / Malay Dutch Norsk नेपाली Wikang Filipino English (Pirate) اردو Twi (Ghana) Polski Português (Portugal) Русский язык العربية Svenska Slovenčina Slovenščina ภาษาไทย Türkçe 中文(Traditional) Українська Tiếng Việt Swahili language Zulu (South Africa) Afrikaans (South Africa) Igbo (Nigeria) Bambara (Mali) Hausa (Nigeria) Yoruba (Nigeria) Latvia Suomeksi Беларуская мова Српски Srpski Қазақша Bosanski Hrvatski پښتو Somalia Ecuador Luganda (Uganda) Turkmen language Ewe (TOGO) አማርኛ Kurdî Malagasy ភាសាខ្មែរ Moroccan Darija Mongolian Tounsi Lingala

First Contributions

This project aims to simplify and guide the way beginners make their first contribution. If you are looking to make your first contribution, follow the steps below.

If you're not comfortable with command line, here are tutorials using GUI tools.

fork the repository

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button, then on SSH tab and then click the copy url to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

copy URL to clipboard

For example:

git clone [email protected]:this-is-you/first-contributions.git

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

Create a branch

Change to the repository directory on your computer (if you are not already there):

cd first-contributions

Now create a branch using the git switch command:

git switch -c your-new-branch-name

For example:

git switch -c add-alonzo-church
If you get any errors using git switch, click here:

If the error message "Git: switch is not a git command. See git –help" appears, it's likely because you're using an older version of git.

In this case, try to use git checkout instead:

git checkout -b your-new-branch-name

Make necessary changes and commit those changes

Now open Contributors.md file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.

git status

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add Contributors.md

Now commit those changes using the git commit command:

git commit -m "Add your-name to Contributors list"

replacing your-name with your name.

Push changes to GitHub

Push your changes using the command git push:

git push -u origin your-branch-name

replacing your-branch-name with the name of the branch you created earlier.

If you get any errors while pushing, click here:

  • Authentication Error

    remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.

first-contributions (firstcontributions/first-contributions)

Searching Database…

56.4K ·GitHub
First-contributions
Что это такое?Это репозиторий-учебник для новичков, который шаг за шагом проведёт вас через первый вклад в проект с открытым исходным кодом.
Это инструмент или просто руководство?Это чисто практический учебный репозиторий: вы делаете его форк, редактируете файл и открываете pull request, чтобы отработать настоящий процесс работы на GitHub. Ничего устанавливать не нужно.
Нужно ли установить Git перед началом?Да, на вашем компьютере должен быть Git. Если его нет, в README есть ссылка на инструкцию по установке. Также там предложен вариант с графическим инструментом для тех, кому неудобно работать в командной строке.
С какой самой частой проблемой сталкиваются люди?Команда git push может завершаться ошибкой аутентификации по паролю, так как GitHub отключил вход по паролю в августе 2021 года. Поэтому вместо пароля нужен персональный токен доступа.
Что именно нужно изменить в репозитории?Вы открываете файл Contributors.md и добавляете своё имя где-нибудь в середине файла (не в начале и не в конце), после чего сохраняете это единственное изменение коммитом.
Можно ли сделать это без командной строки?Да, в README есть ссылки на руководства по внесению изменений с помощью графических инструментов Git, если вам неудобно работать в терминале.
Есть ли это на языках, отличных от английского?Да, в README указано, что его можно читать на других языках, а ссылки на переводы приведены в верхней части файла.
What are similar projects?Project-Ideas-And-Resources, awesome-for-beginners, opensource.guide, Spoon-Knife, git-github-learning-quest, GitTutorial, introduction-to-github, cognee
Which topics is it in?contributions-welcome, good-first-issue, beginner, community, collaboration, github, git, beginner-friendly, guide, learning, tutorial, education
Creator
firstcontributions
Size
51.3 MB
Stars
56.4K
Updated
CommitOct 19
Age
10y
Commits · 90 Days