diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f95d690 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c8e9c7f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# 🏨 Contributing to QuickStay + +Welcome, and thank you for your interest in contributing to **QuickStay**! We're building a full-stack hotel booking application to help users find and book stays seamlessly. Your support is crucial for making this project a success. + +Whether you're a developer, designer, or documentation writer β€” **you can make a difference here.** πŸš€ + +--- + +## πŸ“œ Code of Conduct + +To ensure a safe and inclusive environment for everyone, please read and follow our [**Code of Conduct**](CODE_OF_CONDUCT.md). We expect all contributors to adhere to these standards. + +--- + +## πŸš€ How You Can Contribute + +There are many ways to contribute to the project. Every contribution is highly appreciated! + +* πŸ› **Fix Bugs:** Find and resolve issues to improve stability. +* ✨ **Implement New Features:** Help build features from our roadmap, like payment gateways or map views. +* 🎨 **Enhance the UI/UX:** Improve the user interface and the overall booking experience. +* πŸ“š **Improve Documentation:** Clarify setup instructions, comment code, or improve our guides. +* πŸ”§ **Refactor Code:** Help optimize backend performance or make the frontend code more maintainable. +* πŸ” **Review Pull Requests:** Help us review contributions from others. + +--- + +## πŸ”§ Getting Started: Your First Contribution + +Ready to make your first contribution? Here’s how to get set up. + +### 1️⃣ Find an Issue to Work On + +- Check our [**GitHub Issues**](https://github.com/manishkumar8312/Hotel-Booking/issues) for tasks labeled `good first issue` or `help wanted`. +- **Important:** Before you start working, please comment on the issue to ask for it to be assigned to you. This prevents duplicate work. +- If you have a new idea, please open a new issue to discuss it before creating a pull request. + +### 2️⃣ Fork & Clone the Repository + +- Click the **Fork** button at the top-right of the page to create a personal copy. +- Clone your forked repository to your local machine: + ```bash + git clone https://github.com//QuickStay.git + cd QuickStay + ``` + +### 3️⃣ Create a New Branch + +- Create a new branch with a descriptive name for your feature or fix. + ```bash + # For a new feature + git checkout -b feat/hotel-search-filters + + # For a bug fix + git checkout -b fix/user-dashboard-crash + ``` + +### 4️⃣ Set Up The Environment + +This is a critical step to run the project locally. + +**A. Create Environment Variables** +You must create `.env` files in both the `server/` and `client/` directories. These files are ignored by Git and hold your secret keys. + +- Refer to the `README.md` for the full list of required variables like `MONGO_URI`, `CLERK_SECRET_KEY`, and `VITE_CLERK_PUBLISHABLE_KEY`. + +**B. Install Dependencies and Run the App** + +- **Backend (Server):** + ```bash + cd server + npm install + npm run server + ``` + +- **Frontend (Client):** + ```bash + cd client + npm install + npm start + ``` + +### 5️⃣ Make and Commit Your Changes + +- Write your code and implement your changes. +- Follow our commit message format for clarity. + +```bash +# Example +git add . +git commit -m "feat: add price range filter to hotel search" + ``` +--- + +## ✍️ Commit Message Format + +We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. Please format your commit messages as follows: + +`type: short description` + +- **feat:** A new feature (e.g., `feat: add user reviews section`) +- **fix:** A bug fix (e.g., `fix: correct booking date validation`) +- **docs:** Changes to documentation only +- **refactor:** Code cleanup or restructuring without changing functionality +- **test:** Adding or improving tests +- **chore:** Build process or dependency updates + +--- + +## βœ… Submitting a Pull Request + +Once your changes are ready, it's time to create a Pull Request (PR). + +1. **Push your branch** to your forked repository: + ```bash + git push origin your-branch-name + ``` +2. Go to your forked repository on GitHub and click **"Compare & pull request"**. +3. Fill out the PR template with a **clear title** and a **detailed description** of your changes. +4. **Link the issue** you are solving by including `Closes #` in the PR description. +5. **Check your work** one last time using the checklist below. + +### Pre-PR Checklist + +Before you submit, please make sure you've done the following: +- [ ] I have tested my changes locally and they work as expected. +- [ ] My code follows the project's coding style and conventions. +- [ ] My commit messages are clear and follow the established format. +- [ ] I have updated the documentation if my changes require it. +- [ ] This PR is focused on a single issue or feature. + +--- + +## πŸ™ A Note from the Maintainers + +Thank you for taking the time to contribute! Your efforts help make **QuickStay** a better platform for everyone. We're excited to see your contributions and collaborate with you. + +
+
+ Your contributions help create a seamless booking experience for everyone! +
\ No newline at end of file