Skip to content

This system was created to organize the flow of files and folders and the way to name them, and its goal is to facilitate knowledge of the history of each file and folder where every amendment is bound by law

License

Nick390/regulation.md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 

Repository files navigation

This system was created to organize the flow of files and folders and the way to name them.

The name of the following write method is: Nick390 regulation method or NR method.

It's goal is to facilitate knowledge of the history of each file and folder where every amendment is bound by law for a process push to github and the commit that have been written. This system also regulates the way of writing and naming things, which works on almost all systems, and makes reading and writing easy. Having an organized way of writing texts makes the writing prediction process easier and consistent.

Definitions

For Folders
  • Create Used when new folder has created.
  • Rename Used when a previously existing folder is renamed.
  • Delete When a folder is deleted.
  • Change When folder location change to another location.
For Files
  • Create Used when something new that wasn't there before is created.
  • Update Used when an existing file is modified.
  • Rename Used when a previously existing file is renamed.
  • Add When adding a new property to an existing file.
  • Delete When a file is deleted.
  • Remove When removing a property from an existing file.
  • Fix When a bug of code is fixed or a property is fixed.
  • Change When file location change to another location.
  • Rreplace When file replaced by other file and does same work.
  • Comment Used when placing a line as a comment.
  • Improve Used whene a better version has been provided that does the same task as the previous one, but with less time, or improvement in the user interface, or a better arrangement of the code.

How is the title chosen?

An address is chosen on the largest thing that has been done,for example writing a file consisting of 1000 lines of software is more powerful in mentioning than renaming a file this is due to the preference of those who did a job but when the (push origin) done you have to choose the trick is to make it accurate and attractive at the same time.

In optional extended description

Here you sail and go deeper into it. You must mention everything you have done, including that in the main title. You must put an asterisk*before each item and a point at the end of each item you have made.

Examples
  • **Add text coloring property.
  • **Fix Page not specified error.

Additional information

  • Any modification less than 30 characters is preferable not to be (push origin).
  • Try all the time to format the code as possible.
  • Put a lot of notes in files especially long files or require modification before applying that kind of file or all of them.

How to format file and folders names in the system core?

Using uppercase and lowercase letters was useful in the past, but now because the project has become large, it was decided to make the names in small English letters only; And the words are separated with a symbol _.

How are tables named in the database?

  • No specific method of naming has been specified, but now there is a law so that all column names must be in lowercase letters only.
  • The underscore symbol _ is used to distinguish between words.
  • A comments must be created to describe what each column does.

Timestamp

To be consistent with all the regulation, need to avoid / are replaced with _ in time you can add :.


Examples

New commit
  • Update index.html
    • **Add new H1.
    • **Remove old h2.
    • **Fix javascript path to file.
Nameing folders, files, database tables
  • all_templates.
  • home_page.html.
  • email_verification.
Timestamp
  • 2023_04_27 12:53:58 AM.
functions and more
  • function update_user_password().
  • let user_id = id.
  • https://website_name.com/update_user_name.

About

This system was created to organize the flow of files and folders and the way to name them, and its goal is to facilitate knowledge of the history of each file and folder where every amendment is bound by law

Resources

License

Stars

Watchers

Forks