Whenever we have team projects, there are always concerns on unequal contributions from members of a project team. In the ideal world, we are all here to put in our best efforts and learn together. Even in that ideal world, we have different skill sets and preparations, and we will still contribute differently to a project.
Therefore, you are required to post a contribution statement in the root README.md of your GitHub repo. Please beware that your GitHub repo will become public and remain public after the due date of the projects.
Post your title, team members, project abstract and a contribution statement in the README.md file. This is a common practice for research scientific journals.
Below is an example. If no contribution statement is provided, we will insert a default statement that goes "All team members contributed equally in all stages of this project. All team members approve our work presented in this GitHub repository including this contributions statement. "
Sample project README statement.
Project xxx
Team members: Avi Bond, Comma Deed, En Funn, Gem Hon
Summary: In this project, we developed a new method and improved the classification accuracy for images of cats and dogs to 99.9%
[Contribution Statement] AB, CD, EF and GH designed the study. AB and CD developed baseline classification model for evaluation. EF and GH explored feature engineering for improving the baseline model. AB, EF and GH discussed and designed the model evaluation protocol. CD carried out the computation for model evaluation. All team members contributed to the GitHub repository and prepared the presentation. All team members approve our work presented in our GitHub repository including this contribution statement.