Skip to content

Commit

Permalink
remove doc writing feature from ready repo
Browse files Browse the repository at this point in the history
  • Loading branch information
mursalatul committed Jan 23, 2024
1 parent a7cc933 commit 81e87fa
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 168 deletions.
42 changes: 42 additions & 0 deletions CHECK_MY_UPDATE.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import os

from ADMIN.MAINTAIN.classes.Files import Files


def main():
# welcome message
print("Preparing the repository for commit.".center(50, "*"))
print("\nFolder/File naming format checking . . . . . . . .")
ff = Files()
data = (ff.get_all_valid_folder_files_dict(os.getcwd()))
if "ERROR" in data:
# show relevent error message
# if error with the folder name
if data["target"] == "folder":
# show error message and relavent error(RESTRICTED_CHAR)
print(f"Wrong folder naming. \nYou have used \"", data["ERROR"], "\" in your folder name", sep="")
# show the folder name with error
print("->", data["name"])
# if error with file name
else:
# show error message and relavent error(RESTRICTED_CHAR)
print(f"Wrong file naming. \nYou have used \"", data["ERROR"], "\" in your folder name", sep="")
# show the file name with error
print("->", data["name"])
print("\nChecking process ended with error!")
else:
print("Checking process ended. All Folder/File names are seems good!\nYou are ready to commit and push/pull request")

# ending message
print("\nSome key points to remember:")
print("* make sure you are running this program just before the commit.\n\
* DOCUMENTATION.md will be auto updated after your pull request accepted.\n\
* do not modify this program. this is build to reduce your effort.\n\
* if you find any bug/suggestion feel free to submit an issue at\n\
https://github.com/mursalatul/code-park/issues/new \n\
* see the CONTRUBUTION.md(https://github.com/mursalatul/code-park/blob/master/CONTENT/CONTRIBUTE.md)\n\
if you are confused about contributing in this project.\n")

if __name__ == '__main__':
main()

168 changes: 0 additions & 168 deletions READY_REPO.py

This file was deleted.

0 comments on commit 81e87fa

Please sign in to comment.