Never Nest more then 3 deep

Invert Happy path out of code

File Names should like variables, should tell exactly what that file is for. This way you can use a quick file search to find exactly what that file is for and to keep it getting confused with other similar named files.

For example lets say you want to create a webpage for your sites members. Some of the files you might need are a member page, member component, member interface,  member schema, member controls, member forms. Unless you carefully name these files you will have hunt down the file you are looking for in the directory tree.

// Here is an example of the names you could use for your files:
MemberPage.*
MemberComponent.*
MemberSchema.*
createMember.*
findMember.*
patchMember.*
MemberForm.*
MemberInterface.*

In the above case if you were creating a React Component for Member, even though the file is named MemberComponent you could still name the component Member.

// File Name is MemberComponent.tsx
const Member = () => {

  const {member} = useContent(MemberContext);

  return (
    <div>member.name</div>
  )
}

import Member from '@components/MemberComponent'
// ...code
const App = () => {
  return (
    <MemberContext.Provider value={{member}}>
      <Member />
    </ MemberContext.Provider>
  )
}

File Names

Standards

Code > Comments

Best Practices

Computer Programming is a process of writing instructions for a computer that executes a computer program. Here you will find strategies, standard, best practices and examples of how to writing computer programs.