TA comments

[slumnitz]

Hi everyone,

here are a couple comments for you to consider to implement in the next round.

IMPORTANT: High level documentation about the progress of your project, what each team member contributed and how problems were solved need to be accessible via the project repo in order to assure transparency, therefore commit behaviour needs to be adapted:

• commit frequently! It is best to commit smaller chunks of changes more frequently and design a PR that includes all smaller changes. I.e. you work on adding new functionality, while you develop and debug, you already add 3+ commits. Your PR is about adding this new functionality before you move on to the next function.
• OPTIONAL: in very big projects it is common to use tag words at the beginning of your commit message to indicate which part of the code was chaged, e.g. [DOC] for documentation, [BUG] for fixed bug or [ENH] for adding code or functionality. You could leverage this instead which would shorten your commit messages. I.e. '[ENH] Add year_filter(year = None)`

Note I saw your comment on Slack, commit messages on the committee tracker read well. I would recommend also for you to have proof of your work, as many companies do look at your GitHub account, to try and only make commits consistently with the account you would like to move forward with (i.e. you GitHub.com account).

[techrah]

Regarding the comment to commit frequently, I'm a bit uncertain if this is just friendly advice or as a result of how we've conducted previous pull requests. Each pull request encapsulated some specific logical idea that may or may not have required multiple commits. At the start of a project when I'm doing less specific tasks like getting an initial app framework in place, I may not commit anything as I'm just fiddling with things... until I get something that is actually working. I generally try to ensure that each commit doesn't break the app so that reverting to a previous commit results in an app that still works. As the project progresses, there are then more specific tasks to work on and commits tend to get more granular.

I feel that we are currently committing frequently enough but if this is not the case, perhaps pointing us to specific and concrete instances would be helpful in helping us to better understand the feedback.

[slumnitz]

Hello @ryanhomer,

Regarding the comment to commit frequently, I'm a bit uncertain if this is just friendly advice or as a result of how we've conducted previous pull requests.

is friendly advice. Your thoughts here are absolutely correct! Checking your groups contribution history, with expected equal contribution, this indicates that committing frequently might not be the same for everyone. I am sure your group members appreciate your thoughts here.