Rules

General Rules

  • Communication will be performed via email  
  • Responses to emails should be done within 24 hours 
  • All updates from clients should be notified to the whole team 
  • Update the team on progress regularly. 
  • Meet at least once a week as a group to discuss our progress 
  • Participate in brainstorming sessions and respect other’s ideas 
  • Communicate any other commitments affecting your ability to attend team meetings and complete deliverables beforehand 
  • Communicate with each other and the client respectfully 
  • Always try our best 

Coding Practices

  • Adhere to the client’s coding style (Python PEP8, etc.) 
  • Make sure at least one person reviews your code, 
  • Have descriptive comments and commit messages 
  • Notify members when code is updated or revised to keep communication. 
  • Maintain well-documented code 
  • Make minor changes that work before trying to tackle bigger modifications 
  • Properly document all code with descriptive comments 
  • Make sure code is easy to follow and understand/ using understandable function and variable names 
  • Notify other team members of any potential issues 
  • Comment as much as possible to ensure that other team members can read and understand code written clearly. 
  • Don’t keep files checked out for too long or communicate with team if keeping them checked out for a long time. 
  • Before files are checked in, ensure they work with the current updated state of the app 
  • Use a GitHub project board to ensure that progress is being met