chore: initial setup

.github/Contributor_Guide/Contributing.md

@@ -1,12 +1,12 @@
-# Contribute to <Project_Name>
+# Contribute to Accommodating Insights
 
-Thank you for taking the time to contribute to <project_name>! We really appreciate it. 
+Thank you for taking the time to contribute to Accommodating-Insights! We really appreciate it. 
 
 Before contributing, please make sure to read the [Code of Conduct](../../CODE_OF_CONDUCT.md). We expect you to follow it in all your interactions with the project.
 
-## New to <Project_Name>?
+## New to Accommodating Insights?
 
-If you are new to <Project_Name>, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
+If you are new to Accommodating-Insights, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
 
 ## New Contributor Guide
 
@@ -22,13 +22,13 @@ If you find a bug in the source code, you can help us by [submitting an issue](.
 
 ### Suggesting Enhancements
 
-If you want to suggest an enhancement to <Project_Name>, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
+If you want to suggest an enhancement to Accommodating Insights, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
 
 ### Pull Requests
 
-If you want to contribute to <Project_Name>, submit a pull request.
+If you want to contribute to Accommodating Insights, submit a pull request.
 
-- url: `https://github.com/OPCODE-Open-Spring-Fest/<project_Name>/compare/branch...YOURGITHUBUSERNAME:<project_Name>:BRANCH?quick_pull=1&template=pr.md`
+- url: `https://github.com/OPCODE-Open-Spring-Fest/Accommodating-Insights/compare/branch...YOURGITHUBUSERNAME:Accommodating-Insights:BRANCH?quick_pull=1&template=pr.md`
 
 ### Requirements
 

.github/Contributor_Guide/Project_Tour.md

@@ -1,12 +1,24 @@
 # Project Tour
 
-* notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
-
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+## Folder Structure
+
+* `dataset`: contains the dataset for the project.
+* `Accommodating_Insights.ipynb`: contains the main notebook for the project.
+
+### `dataset` Folder
+
+* `hotel.csv`: is the dataset for the project.
+
+## Coding Style
+
+For Jupyter Notebooks specifically:
+
+* **Cell Organization:** Group related code together in cells and use markdown cells to explain the logic and flow of your notebook.
+* **Comments and Docstrings:** Write clear comments and docstrings for functions and classes to document their purpose and usage.
+<!-- * **Version Control:** Use tools like `nbdime` to simplify version control for notebooks. -->
+
+## Tech Stack
+
+* **Language:** Python
+* **Libraries:** Pandas, NumPy, Scikit-learn, Matplotlib, Scipy, Seaborn, etc.
+* **Tools:** Jupyter Notebook, Git, GitHub, etc.

README.md

@@ -1,2 +1,3 @@
-# template
-A Template Repository for OpenSpringFest (OSF)
+# Accommodating Insights: A Data Exploration of the Transient Landscape
+
+This project delves into a rich dataset containing information about short-term rentals in a geographic location. By analyzing this data, we aim to uncover insights and trends within the rental market.