search

trainline-apprentices / inventory-app

1 stars 0 forks source link

Documentation and Comments #3

Open iDEaXANA opened 10 months ago

iDEaXANA commented 10 months ago

Document the code and add comments where necessary to improve code readability and maintainability.

  1. Make sure to edit issues as you go along as we are lacking the necessary experience to make in-depth and complete issues. This will also serve to be our to-do list, instead of using the Codio checklist (the issues are based on them anyway).
  2. Get into the habit of implementing your own comments into code to let others know what the heck you doin.
  3. ALWAYS COMMIT (https://youtu.be/Wq1TdDsNOzY?t=365)
  4. NEVER push into Main. ALWAYS work on your own branches.
  5. NEVER accept your own Pull Requests. Always get someone else to do it.
  6. REGULARLY pull code into your local main, so you can see where the entire project is at!