search

MadhavM-117 / pacmanJS

Pacman in JavaScript
MIT License
0 stars 0 forks source link

Code Structure and Organization #6

Open MadhavM-117 opened 5 years ago

MadhavM-117 commented 5 years ago

Want to be on the same page, regarding code structure and organization.

adhicoder commented 5 years ago

Cool, let's also do a code review when every pull request is merged. That way we're on the same page and also keeping a check.

On Wed 7 Aug, 2019, 8:48 AM Madhav M, notifications@github.com wrote:

Want to be on the same page, regarding code structure and organization.

  • Let's keep the top level directory, clean.
  • All typescript/javascript should be in the src directory.
  • organize files into an appropriate folder structure, where possible. A flat structure will get too big, and overwhelming, quite quickly.
  • avoid files getting too large.
  • create classes where possible.
  • avoid using the any type.
  • be explicit with types, where possible

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/MadhavM-117/pacmanJS/issues/6?email_source=notifications&email_token=ADZ4HLWA4MV26MGU6OKZD5DQDI5IFA5CNFSM4IJ36QB2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HDY435A, or mute the thread https://github.com/notifications/unsubscribe-auth/ADZ4HLREWNIWXA4QZQEX4K3QDI5IFANCNFSM4IJ36QBQ .

MadhavM-117 commented 5 years ago

Are you suggesting we only merge to master, using PRs, and an approval from the other person? I'm okay with that approach.

MadhavM-117 commented 5 years ago

I can set up branch protection to support that workflow.

adhicoder commented 5 years ago

Yes, that's what I meant. Merge should be approved by another person after review.