search

UBC-MDS / datascience_eda

This package includes functions helping with common tasks during EDA stage of a data science project
MIT License
0 stars 2 forks source link

Update Contributing.md #5

Closed lephanthuymai closed 3 years ago

lephanthuymai commented 3 years ago

Agree upon a collaboration strategy that describes how you will work together on this project (e.g., GitHub flow and edit CONTRIBUTING.md to reflect your strategy. Again, there will be a default version of this file. You can use it as is or adapt it with appropriate attribution. Here are some example CONTRIBUTING.md files for your reference.

Software Carpentry CONTRIBUTING.md factory_bot_rails CONTRIBUTING.md moby CONTRIBUTING.md

rahulkuriyedath commented 3 years ago

@lephanthuymai There already seems to be 2 files in the repo called CONDUCT.rst and CONTRIBUTING.rst. So can we close this issue?

lephanthuymai commented 3 years ago

Please review those files to see if they meet the requirements of the milestone.

On Sat, Feb 27, 2021 at 12:06 PM rahulkuriyedath notifications@github.com wrote:

@lephanthuymai https://github.com/lephanthuymai There already seems to be 2 files in the repo called CONDUCT.rst and CONTRIBUTING.rst. So can we close this issue?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/UBC-MDS/datascience_eda/issues/5#issuecomment-787006705, or unsubscribe https://github.com/notifications/unsubscribe-auth/APHOO7V3VV75ICXZPAG5HZLTBB4VPANCNFSM4YEICK6A .

rahulkuriyedath commented 3 years ago

@lephanthuymai The submission instructions say that we may choose to use the default files that are created or edit it if we want. I think we can leave it as is, since it looks fine. @adibns @charlessuresh Tagging you guys just FYI.

lephanthuymai commented 3 years ago

Hi Rahul, Please check the links in https://github.com/UBC-MDS/datascience_eda/blob/main/CONTRIBUTING.rst, they won't work.

We are using Github flow (branching), the current CONTRIBUTING file is using forking, the requirement says Agree upon a collaboration strategy that describes how you will work together on this project (e.g., GitHub flow and edit CONTRIBUTING.md to reflect your strategy. For new contributors, I agree that we should use forking instead of branching due to the level of trust, but we need to confirm with the instructors if it is ok to have such a difference.

Thanks.