Skip to content

Commit c8e09f4

Browse files
authored
Merge pull request #741 from xebia/manage-innersource-program
more clear messaging on readme priority
2 parents 2495333 + 46292a7 commit c8e09f4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

learn-pr/github/manage-innersource-program-github/includes/2-manage-innersource-program.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,10 @@ A README file communicates expectations for your project and helps you manage co
6060
- Include references to the projects on which you depend. These references are a good way to promote the work of others.
6161
- Use Markdown to guide readers through properly formatted content.
6262

63-
If you put your README file in your repository's root directory, or in the hidden `.github` or `docs` directory, GitHub recognizes and automatically surfaces your README to repository visitors. If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory.
63+
If you put your README file in your repository's root directory, or in the hidden `.github` or `docs` directory, GitHub recognizes and automatically surfaces your README to repository visitors. If a repository contains more than one README file, then the file shown is chosen from locations in the following order:
64+
1. The `.github` directory
65+
2. The repository's root directory
66+
3. The `docs` directory
6467

6568
Check out some [Awesome README examples](https://github.com/matiassingers/awesome-readme?azure-portal=true).
6669

0 commit comments

Comments
 (0)