Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Peart-Guy authored Oct 21, 2024
2 parents f3972e9 + 3d1e22f commit 43adc96
Show file tree
Hide file tree
Showing 33 changed files with 2,605 additions and 813 deletions.
99 changes: 98 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,103 @@ To ensure the quality of contributions to **BuddyTrail**, please adhere to the f

---

# 📂 **Enhanced Project Structure**

This section provides an organized layout of the **BuddyTrail** repository, helping you easily navigate the codebase.

```bash

BuddyTrail/
├── .github/ # GitHub-related configurations and templates
│ ├── ISSUE_TEMPLATE/ # Templates for raising issues
│ ├── assets/
│ ├── scripts/
│ └── workflows/
│ PULL_REQUEST_TEMPLATE.md # Template for creating Pull Requests
├── .idea/ # IDE configuration files (for JetBrains IDEs)
├── .vscode/ # IDE configuration files (for Visual Studio Code)
├── backend/ # Backend logic (may contain API code or backend services)
├── contributor/ # Contributor guidelines and resources
│ ├── contributor.css # Guidelines for contributing to the project
│ ├── contributor.html # Code of Conduct for contributors
│ ├── contributor.js
├── icons/ # Static icons used throughout the project
├── img/ # Image files for the project
├── script/ # JavaScript files for client-side logic
│ ├── popup.js
├── styles/ # CSS stylesheets for different pages and components
│ ├── RatingStyle.css # Styles for star rating feature
│ ├── auth.css # Styles for authentication pages
│ ├── chatbot.css # Styles for chatbot component
│ ├── contact.css # Styles for contact page
│ ├── fly.css # Styles for flight-related pages
│ ├── hotel.css # Styles for hotel-related pages
│ ├── style.css # Main stylesheet for overall site design
│ ├── about.css # Styles for about page
├── .gitignore # Git ignore file to exclude certain files/folders from being pushed to GitHub
├── .gitmodules # Git submodules configuration file
├── LICENSE # License file for the project
├── README.md # Project overview and setup guide
├── project-structure.md # Documentation detailing the project structure
├── project_structure.txt # Text file with the project structure
├── package.json # Project metadata and dependencies
├── package-lock.json # Locked dependencies for reproducible builds
├── about.html # About page for the website
├── auth.html # Authentication page (Sign In/Sign Up)
├── book.html # Booking page for users
├── chatbot.gif # Animated GIF for chatbot feature
├── contact.html # Contact page for user inquiries
├── faq.html # FAQ page
├── fly.html # Flight booking or related page
├── forgot_password.html # Password recovery page
├── hotel.html # Hotel information or booking page
├── index.html # Main landing page
├── reviews.html # Page for user reviews and ratings
├── team.html # Team members page
└── update discussion forum # Discussion forum update file (possibly for changelogs or forum features)
```
---

# 🔥 Pull Request Process
Before submitting your Pull Request (PR), ensure the following:

Complete Testing: Make sure your changes work as expected and have been thoroughly tested.
Adhere to Code Guidelines: Follow the project’s code style and guidelines.
Include Meaningful Commit Messages: Describe what the PR is solving or adding.
Link Issues: If your PR addresses an issue, mention it by adding a link to the issue in the description.

To submit your PR:

Push your branch to GitHub:
```bash
git push origin Feature-Name
```

Go to the repository on GitHub and click New Pull Request.

Complete the PR template, providing as much detail as possible, and submit it for review.

---

# 🐛 Issue Report Process
If you encounter a bug or have an idea for an improvement, please follow these steps to report an issue:

**Search for Existing Issues:** Before creating a new issue, check the Issue Tracker to see if the issue has already been reported.
**Open a New Issue:** If the issue hasn’t been raised yet, click on New Issue and fill out the provided template with as much detail as possible.
**Be Specific:** Provide detailed steps to reproduce the issue, the expected result, and the actual result.
**Include Screenshots/Logs:** If applicable, add any relevant screenshots or log files to help us understand and resolve the issue faster.


# 🌐 Community and Communication

Join the **BuddyTrail** community and collaborate with developers from around the world!
Expand Down Expand Up @@ -150,4 +247,4 @@ Join us and help create a platform that inspires travelers across the globe!

---

Thank you for contributing! Together, we’ll make BuddyTrail the go-to platform for travelers everywhere. ✈️🌍🌟
Thank you for contributing! Together, we’ll make BuddyTrail the go-to platform for travelers everywhere. ✈️🌍🌟
Loading

0 comments on commit 43adc96

Please sign in to comment.