✅ Is My Component Ready For Production (And Going The Extra Mile) Checklist

[vijayxtreme]

Hope you all are enjoying this project and getting some real world practice with things you wanted to learn (especially with React and UI/UX building).

Here's a checklist of things to consider as you build your reusable component (and extra stuff if you want to be an over-achiever).

Basics

• Do I understand the project?
• Am I signed up with Team Hack to contribute (both via the website and via Github)?
• Have I read the available information on the project board (including issues, discussions)?
• Have I chosen a component to work on and created an issue / card on the project board? Did I specify a timeframe/ETA/story point for when I would be able to get this done?
• Do I know how to get help (if stuck) from the members of this team?

Git & Github

• Have I forked this repo?
• Have I created my origin and upstream remotes?
  • Remember upstream is our Team Hack repo, while origin is your forked repo
• Do I understand the file/folder structure for this project?
• Did I install required dependencies (e.g. yarn install, npm install)
• Did I check out a new feature branch?
• Am I working within my own files/folders (as opposed to other files/folders that may be delegated to someone else -- see project board)
• Do I understand which files are meant to be ignored and which are meant to be tracked by .git via .gitignore?
• Have I staged and committed my work for my feature branch (and not to the main branch)?
• Is my repo up to date with the rest of the team before I make a pull request?
• Do I know how to fetch and merge new changes from the upstream main branch to my local main branch?
• Do I know how to merge changes to my feature branch from my updated main branch?
• If there are merge conflicts, am I able to resolve them locally?
• Am I ready to make a pull request?
• Have I pushed my feature branch to my forked repo -- origin (and not upstream -- Team Hack)?
• Did I make a pull request from my forked repo on Github.com to Team Hack?

Code Reviews

• Am I reading feedback about my pull request from the team?
• If my pull request is closed without being merged, do I know why?
• Am I able to make changes suggested by the code reviewer for a closed issue and then make a new pull request?
• Do I keep track of threads and discussions for this project especially under the Please Read and Suggestions area?
• Am I in frequent contact with the rest of the team via Discussions and / or Discord?

Coding

• Is my code error free?
  • Did I lint my code to be free of syntax error?
  • Does my code build? (Can't push code that breaks)
• Does my code work as intended?
  • Have I unit tested this code (and read any discussions about best practices to implement)?
  • Do functions/methods execute properly without breaking the rest of the program?
• Is this code cross browser friendly?
• Does this code slow down the project? If so why? Did I debug? Did I debug for Big O?
• Do I make use of dev tools to properly debug my code?
• Am I aware of code/libraries that can help me write better code or have more performant code?
• Some code/libraries to consider:
  • Error Boundaries in React
  • React.lazy & Suspense
  • React.memo
  • TypeScript | PropTypes
• Am I repeating myself in my code -- or can my code be more DRY?
• Can my code be refactored?
• Am I making commits frequently in small understandable formats or is my code just huge and bloated -- heck I don't even understand it?
• Will I understand this code a few months from now if I go back and read it? How about a year from now?
• Is this something I'd actually put on my resume? If so, can I count on it to get me a little more in the door with my favorite company? If not, why not?

Extra Mile

• Is my code a11y compliant?
• Does my code support internationalization?
• Am I making use of any design patterns? (E.g. Composition over Inheritance, Inversion of Control)
• Have I looked at other ideas out there similar to ours and tried to replicate/incorporate? E.g. Look at top tier open source projects and draw inspiration:
  • Have I shared these ideas with the team?
• Do I have time to code review?
• Can I help with research and more cool suggestions for this or future projects via the board/discussions?

Thanks for reading, and stay tuned -- more updates on the way as always.

Vijay