I renamed these files with following python script:

import os

class RenameFileFromTo:
    def __init__(self, root, filename, new_filename):
        self.root = root
        self.filename = filename
        self.new_filename = new_filename

    def rename(self):
        for root, dirs, files in os.walk(self.root):
            for file in files:
                if file == self.filename:
                    os.rename(root + '/' + file, root + '/' + self.new_filename)

RenameFileFromTo(root_to_java-design-patterns, 'index.md', 'README.md').rename()

Coverage remained the same at 90.939% when pulling bd1b652 on slawiko:slawiko-patch-1 into 528d179 on iluwatar:master.

Ping @iluwatar . What do you think about this? Should we change the convention? I am not sure about this.

@markusmo3 Does this change affect our website?

@slawiko can you list the benefits of this? I can think of browsing the Github repository e.g. https://github.com/iluwatar/java-design-patterns/tree/master/abstract-factory and then Github would show the contents of the README.md automatically.

Yes this would affect the website. But no huge changes would have to be made to make it work with README.md files.

It would improve readability on github(as seen here), so people that dont like our 'beautiful' website with its 'awesome' features could still browse on github

👍 from me

If @iluwatar and @npathai are okay with this i'll take over this issue

@markusmo3 it's ok for me

@iluwatar yes, you're right. It's only for improve readability on github. For example I do not browse your website in general, because for me github - most comfortable place for this.

@iluwatar @markusmo3 @npathai oh, I forgot one thing. We should change developer wiki: all mention of file index.md.

Tested it locally and to my own surprising i dont have to change anything.
Jekyll should work with any *.md files as long as their respective YAML front matter is correct.

@markusmo3 Awesome. 👍
@slawiko Thanks for the PR.

@slawiko I see @markusmo3 already made the changes for developer wiki so this should be in order. Good work guys 👍

@iluwatar @markusmo3 @npathai Thank you, guys. This was my first submitted pull request. THANKS!