Skip to content

Latest commit

 

History

History
118 lines (74 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

118 lines (74 loc) · 3.86 KB
Raw

Contributing to AI Travel Planner App

Thank you for considering contributing to the AI Travel Planner App! Your help is appreciated to improve this AI-powered travel assistant. Please read through the guidelines below to get started.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Branching Strategy
  4. Commit Messages
  5. Code Reviews
  6. Bug Reporting
  7. Feature Requests
  8. Code of Conduct
  9. License

Getting Started

Fork the Repository

If you're not a collaborator, start by forking the repository to your GitHub account.

Clone Your Fork

Clone your forked repository to your local machine.

git clone https://github.com/<your-username>/Eureka-AI_travel_planner_full_stack_app.git
cd Eureka-AI_travel_planner_full_stack_app

Install Dependencies

Install the project dependencies:

npm install

Create a Branch

Create a new branch for each feature or bug fix.

git checkout -b feature/your-feature-name

Make Your Changes

Develop your feature or fix the bug. Make sure your code follows the code quality guidelines and is well-documented.

Commit Your Changes

Commit your changes with a descriptive message.

git commit -m "Add description of your changes"

Push to GitHub

Push your changes to your forked repository:

git push origin feature/your-feature-name

Open a Pull Request

Open a pull request from your branch to the main branch of the original repository. Include a clear description of your changes and reference any related issues.

How to Contribute

  • Features: If you're adding a new feature, ensure it's properly documented and tested.
  • Bugs: For bug fixes, include the steps to reproduce the bug and your solution.
  • Refactoring: Clean up code without changing any functionality.
  • Documentation: Improve the existing documentation or write new documentation to make things clearer for future contributors.

Branching Strategy

We follow this branching model:

  • main: The production-ready branch.
  • develop: The branch for ongoing development.
  • Feature Branches: Create branches for new features using this format: feature/feature-name.
  • Bug Fix Branches: For bug fixes, use the format: bugfix/issue-description.

Commit Messages

Use meaningful commit messages that describe the reason behind the change. Follow the Conventional Commits specification for consistency. Some examples:

  • feat: Add user authentication with Firebase
  • fix: Resolve issue with AI-generated travel plan rendering
  • docs: Update setup instructions for Firebase

Code Reviews

Before your pull request is merged, it will go through a code review by other contributors. Be open to feedback and ready to make necessary adjustments. Your pull request must meet these requirements:

  • Clean Code: Follow best practices for clean code.
  • Testing: Ensure the functionality has been tested, especially if it affects core parts of the app.
  • Documentation: Provide or update relevant documentation when needed.

Bug Reporting

If you encounter a bug, create an issue in the repository with details on how to reproduce it. Include screenshots or error messages where applicable.

Feature Requests

Want to propose a new feature? Open an issue and describe your idea. If possible, include examples or mockups of how the feature could work.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code, ensuring a welcoming and inclusive environment for everyone.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.