Skip to content

Latest commit

 

History

History
247 lines (164 loc) · 8.96 KB

CONTRIBUTING.md

File metadata and controls

247 lines (164 loc) · 8.96 KB

✨ Contributors Guide ✨

Welcome to my READMEasy📝 project!
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Line

What you can Contribute?

🐞Bug Fixing : Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team.

✨Enhancements : Contributors can enhance the project by implementing new features or improvements suggested by users. This involves understanding requirements, designing solutions, and extending the functionality of the travel website. 🚀

📝 Documentation : High-quality documentation is essential for the success of the project. Contributions to the documentation help ensure that users and contributors can understand and use the travel website effectively.

Line

🧾 General Guidelines

  • Communication: If you're unsure about a fix or feature, please open an issue or ask questions in the issue’s thread before proceeding.

  • Documentation: Make sure to update or add relevant documentation, including comments in the code, if you’re working on a feature.

  • Testing: Run tests after implementing your changes and write new ones if necessary. The project uses [testing tool/framework] for verification.

  • Code Style: Follow the coding standards outlined in the style guide.

  • Reporting Bugs: If you encounter any bugs, feel free to report them.

  • Suggesting Features or Enhancements: We welcome new ideas and suggestions!

  • Submitting Code: Keep your pull requests focused on a single change to make reviews easier.

  • Commit Message Format: Use meaningful and descriptive commit messages.

Line

Community Guidelines 🤝

Please follow these guidelines while contributing:

  • Be respectful and considerate towards others.
  • Use inclusive language and foster a welcoming environment.
  • Avoid personal attacks, harassment, or discrimination.
  • Keep discussions focused on constructive topics.

Line

Important Guidelines ⚡

  • Contributors should only work on issues that have been assigned to them.

  • Each pull request should be associated with one issue only.

  • No minor text edits should be submitted unless necessary.

  • Unethical behavior, tampering with files, or harassment will result in disqualification.

  • Follow the community guidelines while contributing to ensure a healthy collaborative environment.

    Line

Getting Started

Prerequisites

  • Node.js (LTS version recommended)

Fork the Repository

  1. Navigate to the main repository on GitHub.
  2. Click the Fork button at the top right to create a copy of the repository on your GitHub account.

Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/<your-username>/<repository-name>.git
cd <repository-name>

Install Dependencies

Install the necessary dependencies using npm or yarn:

# Using npm
npm install

# Using yarn
yarn install

Run the Development Server

Start the development server to ensure everything is set up correctly:

# Using yarn
yarn dev

Open your browser and navigate to http://localhost:5173 (or the port specified) to see the app running.

Making Changes

Create a New Branch

Before making any changes, create a new branch:

git checkout -b feature/your-feature-name

Make Your Changes

Make the desired changes to the codebase using your preferred code editor.

Test Your Changes

Ensure that your changes do not break existing functionality:

# Run tests (if available)
npm test
# or
yarn test

Build the Project (Optional)

To test the production build:

# Using npm
npm run build

# Using yarn
yarn build

Submitting a Pull Request

Commit Your Changes

Add and commit your changes with a descriptive message:

git add .
git commit -m "Add feature: description of feature"

Push to Your Fork

Push the changes to your forked repository:

git push origin feature/your-feature-name

Create a Pull Request

  1. Navigate to your fork on GitHub.
  2. Click the Compare & pull request button.
  3. Ensure the base fork is the original repository and the base branch is main (or the appropriate branch).
  4. Provide a clear and descriptive title for your pull request.
  5. In the description, explain the changes you've made and any relevant context.
  6. Submit the pull request.

Code Review and Merging

  • Review Process: Your pull request will be reviewed by maintainers. Please be responsive to any feedback and make necessary changes.

  • Merging: Once approved, your pull request will be merged into the main codebase.

  • Delete Branch: After merging, you can safely delete your branch:

    git checkout main
    git pull upstream main
    git branch -d feature/your-feature-name

Line

Summary

  • Drop a Star ⭐ in this repo
  • Take a look at the existing Issues.
  • Fork the Repo & create a branch for any issue that you are working on and commit your work.
  • At first raise an issue in which you want to work
  • Then after assigning only then work on that issue & make a PR
  • Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
  • REMINDER: Don't raise more than 2 Issue at a time
  • IMPORTANT: Don't make any type of Pull Request until & unless you get assigned to an Issue
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

Thank you for your contribution!!

Line

Development Workflow 📈

When contributing to this project, please follow these guidelines:

  • Always work on a new branch for each issue or feature.
  • Keep your branch updated with the main repository's master branch.
  • Write clear and concise commit messages.
  • Test your changes thoroughly before submitting a pull request.
  • Keep discussions respectful and constructive.

Line

Issue Report Process 🚩

  • Go to the project's issues section.
  • Choose the appropriate template for your issue.
  • Provide a clear description of the issue.
  • Wait for someone to look into it before working on it.
  • Work on the issue only after it has been assigned to you.

Line

Pull Request Process 🚀

  • Ensure that your code is self-reviewed before submitting.
  • Provide a detailed description of the functionality or changes made.
  • Add relevant comments in your code, especially for complex sections.
  • Submit your PR using the appropriate PR template.

Line

Need more help? 🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
How to create a Issue
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show some  ❤️  by  🌟  this repository!

# Contributing to the READMEasy