Set up GitHub repository with default folders

[gtmx23]

(From Milestone 1 description) Create project structure for the software package

• Create the project structure for your software package appropriate for the language you have chosen, and push it as a public repository in the UBC-MDS organization on Github.com.

  • If you are choosing to work in the Python programming language, there is a quickstart guide for setting up the structure for Python project, you can find it here. This time when you are prompted as whether to include GitHub Actions, say yes! In particular, choose option 3 (build + deploy).
  • If you are choosing to work in the R programming language use the devtools and usethis package for setting up the structure for R project.

• The name of the repository should be relevant to the package/project topics.

• During project creation, you will be prompted to pick a license and for now choose the MIT license. You may change it later when you learn more about licenses.

• Once the projects have been created, add a section to the README.md file called ## Contributors and listing the contributors’ names there (i.e., the names of the members of your student team).

• Edit CONDUCT.md to include the code of conduct for contributing to your project. The intention behind creating this file is fostering a healthy and positive work dynamic. Recall that you already have done something similar in DSCI 522, and you can start with that document and adapt it for your new team. Note that when you create the project structure with the methods above, a default version of this file will be created. You may choose to use it or adapt it with appropriate attributions.

• 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

• Outline the package you would like to build in the README.md file. (This can be identical for both projects at this point in the project). In particular, your README.md should contain:

  • a summary paragraph that describes the project at a high level
  • a bulleted list of the functions (and datasets if applicable) that will be included in the package (this should be a 1-2 sentence description for each function/dataset)
  • a paragraph describing where your packages fit into the Python ecosystem (are there any other Python packages that have the same/similar functionality? Provide links to any that do. If none exist, then clearly state this as well).

[gtmx23]

As discussed during the meeting, I will help with writing the README file. Thanks @Sampsonyu for setting up the default folders! As mentioned, could you just check/edit the conduct/contributing documents haha I thinnk everything else looks good!