Update README.md

This commit is contained in:
Philip Torchinsky 2024-11-24 18:42:43 +02:00 committed by GitHub
parent 7501895702
commit c21fa124ea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -28,11 +28,11 @@ If you represent a primary or secondary school and you are certain of the necess
To add a domain, make a pull request. You must be familiar with git tool or GitHub user interface in order to make a pull request.
We will review your request, and if we accept that it meets all the following conditions then we will merge it:
1. Each domain is represented by a single `.txt` file in the repository. If there is a file `lib/domains/edu/mit.txt`, it means that an email domain `mit.edu` is included in the repository. Please note that the repository reverses the order of the name components, and also note that **.txt extension is mandatory**. Example: add file `/lib/domains/ng/edu/unaab.txt` to add a domain `unaab.edu.ng` to the repository.
1. Each domain is represented by a single `.txt` file in the repository. If there is a file `lib/domains/edu/mit.txt`, it means that an email domain `mit.edu` is included in the repository. Please note that the repository reverses the order of the name components, and also note that **.txt extension is mandatory**. Example: add a file `lib/domains/ng/edu/unaab.txt` to add a domain `unaab.edu.ng` to the repository.
2. Pull requests can include one or more files which you wish to add.
3. Each file in the repository has to contain the name of the university, which the domain represented by the file belongs to. For example, a file `/lib/domains/ng/edu/unaab.txt` has to contain a line in it: *"Federal University of Agriculture, Abeokuta"*.
3. Each file in the repository has to contain the name of the university, which the domain represented by the file belongs to. For example, a file `lib/domains/ng/edu/unaab.txt` has to contain a line in it: *"Federal University of Agriculture, Abeokuta"*.
The first line of the file has to contain the official name of the educational organization.
Other lines can contain other names the university is known by. A university in a non-English speaking country can have a line containing the university name in their native language, and another line with the name in English.