Skip to content

Fork pull request #1032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 120 commits into
base: fix/bad-links
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
120 commits
Select commit Hold shift + click to select a range
ede02bc
Added a resource (#714)
uday03meh Jun 3, 2022
df0a764
Update link to Think Like (a) Git (#717)
fbtot Jun 3, 2022
6e3e429
github learning resources link updated (#720)
YaSh8202 Jun 3, 2022
c567055
Updated README.md accordin to #705 (#718)
TenTraicion Jun 3, 2022
87129bc
Update Arabic README Open Source Initiatives (#722)
0xGhada Jun 6, 2022
0c93f79
Update list of language and added item Arabic language (#723)
0xGhada Jun 6, 2022
5922cfb
fix: bad links #706 (#725)
prasanta10 Jun 7, 2022
3f29121
Added Harvard University's Video Tutorial on Git and Github (#728)
SwapnilThatte Jun 7, 2022
ec210db
Update ReadMe - language HE link addition (#574)
YaadR Jun 8, 2022
456091a
Fix README-LOCALE.md Hyperlinks to be Clickable (#555)
altela Jun 8, 2022
60f3db1
Added Translation for Sinhala (#646)
asankaSovis Jun 10, 2022
59ae5bb
added contribution in README-PT-BR (#614)
MariaTheresa1 Jun 10, 2022
c398d7a
Add helpful link (#463)
archy-coder Jun 10, 2022
ecc1458
Resolve redirection of Github guides (#732)
SangamSwadiK Jun 10, 2022
f332100
fixed bad links; removed forward slashes (#733)
marahim20 Jun 11, 2022
e1f61ec
Fix : Added Tamil language readme link in the <ul> list (#734)
mtmfahathdev Jun 13, 2022
f8962fe
Updated README.md File (#737)
Nik6511 Jun 14, 2022
4df2043
Update readme.md with FOSS acronyms link #620 (#739)
angieloux Jun 19, 2022
d1c505f
chore: add OSWC to the OS contribution initiatives list (#740)
Panquesito7 Jun 19, 2022
8cae97e
fix: Added a link to Nepali language README-NE.md file (#736)
Nik6511 Jun 19, 2022
027825b
add SSOC to OS initiatives & OS programs list (#741)
Astrodevil Jun 21, 2022
4eef7f8
Translated first paragraph to be more native sounding (#744) (#745)
worldwidepaniel Jun 25, 2022
c889ff2
Added an Open Source Article Link and solved Issue #701 (#743)
sanjeeban5644 Jun 28, 2022
50ca760
Format test.yml file
erictleung Jun 28, 2022
b718b46
Move links between sections and add descriptions
erictleung Jun 28, 2022
1296c79
Translated document in Bangla (বাংলা) language. (#612)
jewelcse Jun 28, 2022
64a5401
Updated Bangla section "Open-Source contribution initiatives" (#650)
RoisulIslamRumi Jun 28, 2022
f69849d
Replaced build status badge in README (#747)
kumar-kalyan Jun 28, 2022
f010bb3
Replace build status badge in all README.md language variations (#748)
melvincwng Jun 28, 2022
140d2ef
Added a Git Tutorial Link in README.md file. (#749)
sanjeeban5644 Jun 30, 2022
2149d77
Update README.md (#753)
Oberkoh Jul 10, 2022
1e21e89
Update README.md (#754)
Oberkoh Jul 10, 2022
d189ee2
Fix typo in README-KO.md : need to add a space character (#760)
Jul 20, 2022
b440a47
i corrected a word :) (#762)
0xGhada Jul 22, 2022
ff056b0
Add French translations in "Using Version Control" and fix typo (#756)
dansonserge Jul 22, 2022
4672ead
Target all README files in GitHub Actions check (#763)
madhhuurrii Jul 23, 2022
408f9ba
Corrects the Italian translation in README-IT.md (#761)
Jar1M Jul 25, 2022
f398f29
Updated README.md with Adding new resources. (#458)
jayasahan Jul 25, 2022
a4abe8a
Added an open source link (#465)
prabhpreet-code Jul 25, 2022
4545851
Moved git link from Open Source Books to Version Control (#766)
jjalbuenacabuyao Jul 26, 2022
32666cf
Added description to sections in README-FR.md (#767)
jmarc101 Jul 27, 2022
1abae2b
removed duplicates from program list (#769)
gyro5 Jul 27, 2022
57f508e
Fix: Corrected a grammatical mistake. (#772)
alisbai Aug 8, 2022
1826443
README-UR (Updated).md (#779)
amiarham Aug 31, 2022
c0c81cb
Added Punctuation (#789)
nuckarronjones Sep 6, 2022
96ebc34
Fix typo (#790)
yogevitz Sep 28, 2022
2bdce7c
Typo, missing full stop in the line 62. (#798)
shonebinu Oct 4, 2022
5a8d4ce
Fixing links (#793)
VahilaK Oct 26, 2022
0d6d90e
Adds link to Readme Line 92. (#803)
pranjal779 Oct 26, 2022
483cc5c
Added an open source link (#815)
salaheddinelhamraoui Oct 27, 2022
700878c
Update README.md (#812)
Arijit1000 Oct 27, 2022
57d7eef
I fixed link of social summer code (#809)
0xGhada Oct 27, 2022
9df4a81
Lexical and grammar review to the Italian version of README (#816)
MatteoBira Nov 5, 2022
afdf1db
docs: fix grammatical errors & links in README of Hindi language (#799)
Rahulbaran Nov 5, 2022
aac7a31
some words are translated to nepali (#837)
pawanrijal Dec 27, 2022
7cce448
Fix typos and make phrases consistent (#836)
aakashditya Dec 27, 2022
da53f55
Add details to CONTRIBUTING.md (#839)
erictleung Dec 27, 2022
9600fb0
Added article on PR best practices from DoorDash Engineering (#792)
tonyxrandall Dec 27, 2022
316844c
Grammar correction in README-HI.md (#776)
Vedant-rai Dec 27, 2022
c27f97e
Translated README.md in Urdu Language. (#774)
Dec 29, 2022
612f9ee
Adding 'ifme' project in PROJECTS.md (#782)
VahilaK Dec 29, 2022
5493a89
Add CONTRIBUTING section on choosing an issue (#840)
erictleung Dec 30, 2022
bc9c8a7
Fix of typos and grammatical errors in the German README-version (#842)
felixschwebel Jan 9, 2023
0c4f815
removed broken 'pull request roulette' link (#850)
MojoRed3 Jan 23, 2023
f1bda55
Update README.md(New links for Open-Source Contributions) (#846)
cjiayu03 Jan 23, 2023
1361f34
Add Gujarati README.md (#826)
Bhavya031 Jan 23, 2023
e1eaf25
Updated the whitelist, commented out failing code (#844)
felixschwebel Jan 23, 2023
5409671
Translating README.md To Malayalam(On-going) (#526)
varghesejose2020 Jan 23, 2023
99ac6df
fix a link in Direct GitHub searches Sections (#853)
zhangkaihua88 Mar 19, 2023
db1f585
#855 Updated Hindi and MARATHI README files (#856)
prasadj2003 Mar 20, 2023
6a64a08
Issue no #860 resolved (#866)
Santhoshmani1 Mar 30, 2023
81df345
fix: remove inconsistent line break (#872)
howarddo2208 May 21, 2023
87914f4
added beginner friendly resource to resource list (#878)
Dolamu-TheDataGuy Jul 21, 2023
370a914
Updated README-ML.md (#883)
neogit017 Jul 21, 2023
55a8c24
Update Resource Description in README.md (#900)
nikohoffren Jul 26, 2023
fa73ce0
README.MD in Spanish - modified subtitle: tabla de contenido (#895)
ruben-duarte Jul 26, 2023
f000485
Update README-TR.md to almost match with README.md (#858)
CoderZ865 Jul 26, 2023
ee95dee
Remove whatcanidoformozilla.org link from all README (#925)
AhmedLoaySalman Oct 26, 2023
7284c55
Extending "Table of Content" (#923)
maniamartial Oct 26, 2023
c278765
Fixed the formatting in README-DE in the section "Open-Source-Beiträg…
Nov 23, 2023
638cbcf
Fix typo and add the link for Turkish in README-KO.md : wrong space s…
hwahyeon Dec 24, 2023
5a53d0b
Minor style and spelling updates in README-ES.md (#887)
jiug Dec 24, 2023
07e92fb
Translate the README.MD to Ukrainian (#881)
derelif Dec 24, 2023
2e37d8d
Update and rename README-UA.md to README-UK.md (#945)
erictleung Dec 24, 2023
99a1366
fix: italian idiomatic expressions and words, markdown error and warn…
moDal7 Dec 24, 2023
3164549
fix: split the words that should be separate (#902)
mikolaj-mus Dec 25, 2023
22a0b94
Update README-AR.md (#910)
m00I Dec 25, 2023
5d32bc4
Corrected README.UR.md typos and improved language clarity (#888)
Zohaib-Ramzan Jan 5, 2024
9098d3b
fixes/Automate ISO 639 Suffix Check for README Files (#949)
rahat2134 Jan 8, 2024
c71c11b
Fix: Update README-NL.md (#930)
Nadav23AnT Jan 10, 2024
527620d
Update README.md to include description for the Hacktoberfest (#958)
Kit-Kat31415926 Feb 25, 2024
6a3073f
✅ Add Vietnamese language (#563)
DungGramer Feb 26, 2024
4495fe1
Rename README-VN.md to README-VI.md (#965)
erictleung Feb 26, 2024
7787433
README CONVERTED TO UZBEK (#567)
mohit200008 Feb 26, 2024
3151dcd
Update README-AR.md (#955)
IlyasKhallouki Feb 26, 2024
4c21f84
chore: update checkout GitHub Action version (#962)
DarkStarHub Feb 28, 2024
479d933
Contributing to opoen source in general (#874)
daniell54 Mar 7, 2024
7f9b987
Update README-FA.md (#851)
poyap Mar 7, 2024
695d7cd
Update README-RU.md (#876)
ExZellow Mar 9, 2024
253c83d
Update README-CN.md (#880)
cirE0205 Mar 9, 2024
7551939
Added malayalam translation to readme language list (#963)
ByteJoseph Apr 17, 2024
e8c849c
fixed formal and grammatical errors in German README translation (#975)
StackOverflowIsBetterThanAnyAI Apr 18, 2024
7825ef2
Fixed a typo in a link 🔗 (#982)
YuheshPandian Jun 14, 2024
575797f
feat: add contributing.md website (#977)
a2937 Jun 14, 2024
d74d8c3
Create armenian readme file (#862)
Tigran-Khanaghyan Jun 14, 2024
9e5b6dd
Adding Telugu version of the README file (#786)
belohith Jun 14, 2024
43f1fd4
Update README-CN.md (#903)
HashCookie Jun 14, 2024
03a60e2
UPDATES to README.md (ENGLISH) and README-ES.md (Spanish) (#777)
sweetheartxo Jun 14, 2024
651154d
Add new README.md file in Sanskrit language (#988)
pawankumarsaw Aug 27, 2024
56eb016
Solved Issue #989 (#991)
ruhi47 Sep 4, 2024
8834769
Removed domain links that no longer worked on README.ES. (#985)
AbelolDev Sep 4, 2024
e121931
Update: README.md - Add Code Review Anxiety Workbook in opensource bo…
Cibiyanna26 Oct 2, 2024
7f167ab
Update README-NL.md (#994)
Jordy19 Oct 2, 2024
7f079ea
Update README-ES.md (#998)
GregoriM04 Dec 2, 2024
09889a5
Newer link to good first bugs for Mozilla Firefox (#1008)
cr5459 Jan 21, 2025
cd68bc5
Update README-BN.md (#1015)
abdulawalarif Mar 14, 2025
b94494f
Update README-HI.md (#984)
samyuii Mar 14, 2025
cdf777c
Raha farsi readme (#599)
acse-srm3018 Mar 15, 2025
2104955
fix: Add first contribution repo #770 (#1011)
michaelboateng1 Mar 15, 2025
8719fea
Update README-PL.md (#1027)
table106 May 30, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions .github/workflows/language-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Check README Suffixes

on:
pull_request:
paths:
- 'README-*'

jobs:
check-readme-suffixes:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.0

- name: Install dependencies
run: |
gem install nokogiri

- name: Check README suffixes
run: |
# Scrape ISO 639 language codes from the Wiki page
wget -qO- https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes | \
nokogiri -e 'puts $_.css(".wikitable td:nth-child(2)").map(&:text)' | \
sed -nr '/^.{0,2}$/p' | # Grab only two letter values
tr '[:lower:]' '[:upper:]' > iso639.txt # Covert letters to uppercase

# Get list of README file names
readme_suffixes=$(ls README-* | sed 's/README-//g; s/.md//g')

# Check if README suffixes are valid ISO 639 language codes
for suffix in $readme_suffixes; do
if ! grep -qw "$suffix" iso639.txt; then
echo "Error: Invalid README suffix found: $suffix"
exit 1
fi
done

echo "All README suffixes are valid ISO 639 language codes."

# Add more steps for your existing workflow, e.g., running tests or other checks
9 changes: 6 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

steps:
- name: Checkout Source Files
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
fetch-depth: 0

Expand All @@ -25,10 +25,13 @@ jobs:
- name: Run checks
id: checks
# shell: bash +e +o pipefail {0}
# continue-on-error: true
continue-on-error: true
run: |
gem install awesome_bot
awesome_bot -f README.md --allow-ssl --allow 302,429 --white-list firsttimersonly.com,github.com/github,creativecommons.org/licenses/by-sa/4.0
awesome_bot \
-f README*.md \
--allow 302,429 \
--white-list https://www.firsttimersonly.com/,https://github.com/github,https://creativecommons.org/licenses/by-sa/4.0/,https://github.com/kentcdodds

# - name: Run Danger
# uses: MeilCli/danger-action@v5
Expand Down
45 changes: 42 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,40 @@ Issues can be submitted by anyone - either seasoned developers or newbies.

**Contents**

- [Choosing an Issue](#choosing-an-issue)
- [Getting Started](#getting-started)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Adding to the Main README](#adding-to-the-main-readme)
- [Adding to Non-English README](#adding-to-non-english-readme)
- [Adding to the Project File](#adding-to-the-project-file)
- [Notation and terminology](#notation-and-terminology)
- [Helpful Resources](#helpful-resources)

## Choosing an Issue

Before getting started and setup with contributing, you'll want to look at and choose an issue to work on. Here is a basic workflow you want to work from:

1. Search through issues
2. Find issue you want to work on
3. Check if someone else has already worked on and made a pull request on said issue
4. (Optional) Double check pull requests for someone who has worked on the pull request

If you have gotten that far, then you can go ahead and work on the issue. Below are more detailed instructions based on the basic workflow above.

You can find open issue [here](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/issues).

Once you've found an issue you want to work on, take a look at the issue to see if anyone else has made a pull request for this issue yet.

You can tell if someone has correctly referenced and worked on an issue if in the issue you find some text saying, the following:

> This was referenced on ____

where that `____` is the date and below it is the pull request of another individual working on that issue. [Here](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/issues/822) is an example of what this looks like.

To be extra sure no one has worked on it, you can [take a look at the pull requests](https://github.com/freeCodeCamp/how-to-contribute-to-open-source/pulls) as well to see if anyone has made a similar pull request.

If you've gotten this far, then you can continue on with the next section on "Getting Started" to working on your first pull request and contribution to our repository.

### Getting Started

1. If you are new to Git and GitHub, it is advisable that you go through
Expand Down Expand Up @@ -44,7 +71,7 @@ Issues can be submitted by anyone - either seasoned developers or newbies.

If you are making changes to the `README.md` file, you would need to have
Markdown knowledge. Visit
[here to read about GitHub Markdown](https://guides.github.com/features/mastering-markdown/)
[here to read about GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
and
[here to practice](http://www.markdowntutorial.com/).

Expand Down Expand Up @@ -118,13 +145,19 @@ You can contribute to this page by adding a Markdown-formatted link.
It should look similar to the one below.

```
- [Title of the page](www.websitename.com/slug-name-here) - Add a description of why I should look at this site
- [Title of the page](www.websitename.com/slug-name-here) - Add a description of why I should look at this site.
```

When in doubt, take a look at the current list of items to get an idea of how you should format your contribution.

When adding your contribution to the list, please add your link to the most appropriate section. If you are unsure, feel free to ask in your pull request or comment in an issue asking for guidance.

If a video link is added, try to add in the length of the video as well, as shown below.

```
- ["Complete Guide to Open Source - How to Contribute"](https://www.youtube.com/watch?v=yzeVMecydCE) (41:52) - Learn why and how to contribute to open source software with Eddie Jaoude.
```

### Adding to Non-English README

The main `README.md` file is written in English. That file will be the template for all of the other languages.
Expand Down Expand Up @@ -165,10 +198,16 @@ Next, we ask to link to the contributing page. This will give direction to peopl

Lastly, we want to link to beginner-friendly labels. These are typically `Good First Issue` or something similar.

### Notation and terminology

This section will list any notations, terminology, or words that we will keep consistent.

- "Open Source" will be capitalized unless it is within a article or video title

### Helpful Resources

- [Pro GIT Book](https://git-scm.com/book/en/v2)

- [Try Git](https://try.github.io/)
- [Try Git](https://docs.github.com/en/get-started/quickstart/set-up-git)

- [Git/ Git Hub on Windows](https://www.youtube.com/watch?v=J_Clau1bYco)
8 changes: 6 additions & 2 deletions PROJECTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,16 @@ before contributing.
- [*](https://github.com/test-kitchen/test-kitchen/issues?q=is%3Aopen+is%3Aissue+label%3A%E2%AD%90%EF%B8%8F)
- `Django` (Framework)
- [Contributing Guide](https://github.com/django/django)

- `[tsParticles](https://github.com/matteobruni/tsparticles)` (Library)
- [Contributing Guide](https://github.com/matteobruni/tsparticles/blob/master/CONTRIBUTING.md)
- Issue labels:
- [Good First Issue](https://github.com/matteobruni/tsparticles/labels/good%20first%20issue)
- [Help Wanted](https://github.com/matteobruni/tsparticles/labels/help%20wanted)

- `[Jenkins](https://github.com/jenkinsci/jenkins)` (Project)
- [Contributing Guide](https://wiki.jenkins.io/display/JENKINS/Beginners+Guide+to+Contributing)
- `[ifme](https://github.com/ifmeorg/ifme)` (Project)
- [Contributing Guide](https://github.com/ifmeorg/ifme/blob/main/CONTRIBUTING.md)
- Issue labels:
- [first-timers-only](https://github.com/ifmeorg/ifme/issues?q=is%3Aopen+is%3Aissue+label%3Afirst-timers-only)
- [good first issue](https://github.com/ifmeorg/ifme/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- [beginner friendly](https://github.com/ifmeorg/ifme/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22)
Loading
Loading