Project and code management

Code management

Code for your project must be publicly available on GitHub or a similar git repository manager (BitBucket, GitLab, etc.). Your git repository should be well organized and have the following files in addition to your code:

• README.md (md is short for markdown; here's a quick overview Links to an external site.)
• LICENSE (choose an open source license such as MIT, BSD, GPL, or whatever you'd like -- see this page for options Links to an external site.)

Your README.md should include the motivation for and a description of the software. Also include instructions for getting it to run.  Use markdown headers to break things down into sections as appropriate.

You should commit often and push to your git repository manager regularly (at least every week). This will help create a trail of your work and avoid catastrophes such as losing all your work when you spill water all over your computer.

Project management

One way to manage a software project is to follow the Agile method. You should pick an online service for tracking user stories and tasks and send me a link to the project. Break your project into user stories from the perspective of the end user, the developer, and other important stake holders. Estimate how much work each story will be. Each week, choose a few user stories to work on and break them down into tasks. Keep track of each task: pending, in progress, or done.

Two services I recommend:

• Taiga (https://taiga.io/ Links to an external site.)
  • allows kanban and sprint boards
• Trello (https://trello.com) Links to an external site.
  • kanban