'tis hard. 'tis always hard th' first time ye do somethin'. Especially when ye be collaboratin', makin' mistakes ain't a comfortable thin'. We wanted t' simplify th' way new open-source contributors learn & contribute fer th' first time.
Readin' tales & watchin' tutorials can help, but wha''s better than actually doin' th' stuff in a practice environment? This project aims at providin' guidance & simplifyin' th' way beginners make thar first contribution. If ye be lookin' t' make yer first contribution, follow th' steps below.
If ye're nah comfortable wit' command line, here be tutorials usin' GUI tools.
Read this in other languages.
๏ธ๐ฌ๐ง ๐ฎ๐ณ ๐ฒ๐ฒ ๐ฎ๐ฉ ๐ซ๐ท ๐ช๐ธ ๐ณ๐ฑ ๐ท๐บ ๐ฏ๐ต ๐ป๐ณ ๐ต๐ฑ ๐ฎ๐ท ๐ฎ๐ท ๐ฐ๐ท ๐ฐ๐ต ๐ฉ๐ช ๐จ๐ณ ๐น๐ผ ๐ฌ๐ท ๐บ๐ฆ ๐ง๐ท ๐ต๐น ๐ฎ๐น ๐น๐ญ ๐ด๓ ฅ๓ ณ๓ ง๓ ก๓ ฟ ๐ต๐ฐ ๐ง๐ฉ ๐ฒ๐ฉ ๐ท๐ด ๐น๐ท ๐ธ๐ช ๐ฎ๐ฑ
If ye don't 'ave git on yer machine, install it.
Fork this repo by skewerin' on th' fork button on th' top o' this page. This will create a copy o' this repository in yer account.
Now clone this repo t' yer machine. Go t' yer GitHub account, skewer on th' clone button 'n then skewer th' copy to clipboard icon.
Open a terminal 'n run th' followin' git command:
git clone "url ye jus' copied"
where "url ye jus' copied" (without th' quote marks) be th' url t' this repository (yer fork o' this project). See th' previous steps t' obtain th' url.
Fer example:
git clone https://github.com/this-be-ye/first-contributions.git
where this-be-ye be yer GitHub username. Here ye're copyin' th' contents o' th' first-contributions repository in GitHub t' yer 'puter.
Change t' th' repository directory on yer 'puter (if ye be nah already thar):
cd first-contributions
Now create a branch usin' th' git checkout command:
git checkout -b <add-your-new-branch-name>
Fer example:
git checkout -b add-luke-oliff
(Th' name o' th' branch does nah needs t' 'ave th' word add in it, but 'tis a reasonable thin' t' include 'cause th' purpose o' this branch be t' add yer name t' a list.)
Now open Contributors.md file in a text editor, add yer name t' it. Don't add it at th' beginnin' or end o' th' file. Put it anywhere in between. Now, save th' file.
If ye go t' th' project directory 'n execute th' command git status, ye'll see thar are changes.
Add those changes t' th' branch ye jus' created usin' th' git add command:
git add Contributors.md
Now commit those changes usin' th' git commit command:
git commit -m "Add <yer-name> to Contributors list"
replacing <yer-name> with your name.
Push yer changes usin' th' command git push:
git push origin <add-yer-branch-name>
replacin' <add-yer-branch-name> wit' th' name o' th' branch ye created earlier.
If ye go t' yer repository on GitHub, ye'll see a Compare & pull request button. Click on that button.
Now submit th' pull request.
Soon I'll be mergin' all yer changes into th' master branch o' this project. Ye will get a notification email once th' changes 'ave been merged.
Ye can safely scuttle yer branch <add-yer-branch-name> aft th' pull request has been merged. Ye'll see a button t' scuttle th' branch:
If th' Pull Request was closed without bein' merged, GitHub will warn ye about scuttlin' unmerged commits 'n th' button will look like this:
Well done! Ye jus' completed th' standard fork -> clone -> edit -> PR workflow that ye'll encounter often as a contributor!
Celebrate yer contribution 'n share it wit' yer hearties 'n followers by goin' t' web app.
Ye could join our slack crew in case ye needs any help or 'ave any riddles. Join our slack crew.
Now let's get ye started wit' contributin' t' other projects. We've compiled a list o' projects wit' easy issues ye can get started on. Check out th' list o' projects in web app.
 |
 |
 |
|---|---|---|
| GitHub Desktop | Visual Studio 2017 | GitKraken |
If ye liked this project, star it on GitHub. If ye're feelin' especially charitable, follow Roshan on Twitter and GitHub.
