Skip to content

Latest commit

 

History

History
71 lines (60 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

71 lines (60 loc) · 2.91 KB
Raw

Contributing to DIPCar

We welcome your interest in contributing to this project. 🌟Your input is valuable for maintaining and improving the quality of our work. Please ensure that your contributions adhere to ethical standards and maintain professionalism in all interactions with the project. Before making any modifications, we kindly request that you discuss your proposed changes with the repository owner. This can be done through creating an issue, sending an email, or using another appropriate communication method.💬

🔄Submitting a pull request

Follow these steps to guide you through the process:

  • Step 1: Fork the repository and clone it to your local machine. 
    git clone https://github.com/<your_github_username>/DIPCar.git
  • Step 2 📂Navigate to the project directory. 
    cd DIPCar
  • Step 3: 🔗Add an upstream link to the main branch in your cloned repository. 
    git remote add upstream https://github.com/wajht7553/DIPCar.git
    or 
    git clone https://github.com/ImranNawar/DIPCar.git
  • Step 4. 👀View the remote repositories and their URLs 
    git remote -v
  • Step 5: 🔄Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) 
    git pull upstream main
  • Step 6: Create your feature branch (This is a necessary step, so don't skip it) 
    git checkout -b <branch-name>
  • Step 7: 🔍Track and stage your changes. 
     # Track the changes
 git status

 # Add changes to Index
 git add .
  • Step 7: Commit all the changes (Write commit message as "Small Message") 
    git commit -m "Write a meaningful but concise commit message"
  • Step 8: 🚀Push the changes for review 
    git push -u origin <branch-name>
  • Step 9: Create a Rull Request on Github. When creating the pull request, provide a clear message explaining the purpose of your changes and what you are contributing.

✅ Best Practices for Pull Requests

To increase the likelihood of your pull request being accepted, please follow these best practices:

🎨Follow the Coding Style:

Ensure that your changes align with the established coding style used in this project.

🎯Keep Changes Focused:

If you have multiple changes that are independent of each other, consider submitting them as separate pull requests. This allows for better review and easier integration.

📝Write a Good Commit Message:

A well-written commit message is important for maintaining clear and concise commit history. Follow the guidelines outlined in this article to create informative commit messages.

🔄Be Responsive:

After submitting your pull request, be prepared to respond to any feedback or questions from reviewers promptly.

We appreciate your contributions and look forward to reviewing your pull requests! 🙌