We tried to introduce TheAlgorithms/scripts/directory_md into TheAlgorithms/Ruby with TheAlgorithms/Ruby#209, but after the merge it failed to run with the following error:

python: can't open file '/home/runner/work/Ruby/Ruby/build_directory_md.py': [Errno 2] No such file or directory

After discussing this with @Panquesito7 in the PR, it seems that the GitHub Action needs to be modified, so I am reporting it here. Thanks!

Description

Most of the main branches are protected, which means the scripts won't be able to push unless they unprotect the branches, which would be 100% not safe, IMO.
To prevent this, we could create a temporary branch and create a PR to perform the changes without removing branch protection.

Description

TheAlgorithms/C#1242 (comment) for more information about the idea of the script.
Created an issue here as I was planning to also add it in the C++ repository, and potentially other repositories as well.

This is a batch to track the status of a feature where we would create an action to annotate to the user that their files naming convention don't match the contribution guidelines.

• #18
• #19

Description

Currently, we have a readme where it explains the use of the directory builder.
However, that guide is outdated, and we do not have guides for the other script(s).

I suggest we add a README.md inside their respective folders explaining what it does, how it works, etc..
Let me know your thoughts about this. Thank you. 🙂

If this script is to be used by multiple language repos then it should be moved to https://github.com/TheAlgorithms/.github

Description

There's a filename formatter that's being used already in various repositories, such as
the TypeScript repository repository, the C/C++ repositories, and soon other repositories as well.

This is not a Python script but more of a Bash script, I guess.
What do you think? Should we adjust it and add it to this repository? Thanks.

          IFS=$'\n'
          for fname in `find . -type f -name '*.cpp' -o -name '*.hpp'`
          do
            echo "${fname}"
            new_fname=`echo ${fname} | tr ' ' '_'`
            echo "      ${new_fname}"
            new_fname=`echo ${new_fname} | tr 'A-Z' 'a-z'`
            echo "      ${new_fname}"
            new_fname=`echo ${new_fname} | tr '-' '_'`
            echo "      ${new_fname}"
            if [ ${fname} != ${new_fname} ]
            then
              echo "      ${fname} --> ${new_fname}"
              git "mv" "${fname}" ${new_fname}
            fi
          done

CC: @raklaptudirm, @appgurueu, you might want to check this out as well.

For us to be able to finish the filename actions batch, we need to provide our script the capability of returning a list of filenames so that we can use those filenames to send PR annotations to a user.

The main parts of this script already exist, this issue is to track the idea of finding all the filenames that are incorrect and returning (outputting) to the caller.

This is an issue to track the adding annotations to the filename script.

What do we mean by annotations? The following is an example of an annotation generated by a linter called golangci-lint. Generating them is quite straight forward, the docs explain this quite nicely.