Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 3.11 KB

README.md

File metadata and controls

95 lines (71 loc) · 3.11 KB
Raw

🚀 First Commit

Welcome to First Commit, a project designed to help newcomers make their first contribution to open-source! This is a beginner-friendly initiative that guides you through the fundamentals of Git and GitHub—such as commands, pull requests (PRs), issues, and handling merge conflicts. With First Commit, you can easily gain hands-on experience by contributing to a real-world project.

🌟 Overview

First Commit provides an opportunity for developers who are new to open source to take their first step toward becoming contributors. It's a simple project where users add their information, such as their name, GitHub profile link, and designation (e.g., Open Source Enthusiast, UI/UX Designer). Your profile will be displayed as a card on the frontend.

Through this project, you’ll learn:

  • 🛠 Basic Git commands
  • 🐙 Exploring GitHub for collaborative coding and project management
  • 🔧 Making and reviewing pull requests
  • 📝 Creating and resolving issues
  • ⚔️ Handling merge conflicts

⚙️ Project Setup

📝 Prerequisites

Before you begin, ensure you have the following software installed:

  • Git – Version control to manage your code.
  • NodeJS – JavaScript runtime to run the project locally.

🛠 Installation Guide

  1. Fork this repository by clicking the "Fork" button at the top-right corner of this page.
  2. Clone the repository to your local machine: 
    git clone https://github.com/your-username/first-commit.git
  3. Navigate to the project directory: 
    cd first-commit
  4. Install the required dependencies: 
    npm install
  5. Start the project on your local server: 
    npm start
    The project will now run on http://localhost:3000.

🤝 Contributing Guide

Ready to make your first contribution? Follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  3. Make your changes to the codebase.
  4. Stage your changes: 
    git add .
  5. Commit your changes with a meaningful message: 
    git commit -m "Add [your-feature] - a brief description"
  6. Push the branch to your GitHub fork: 
    git push origin feature/your-feature-name
  7. Open a pull request (PR) from your forked repository by going to the original repo and clicking "New Pull Request."

💡 Things to Consider

  • Ensure your code is clean and adheres to the project’s coding standards.
  • Keep your commit messages clear and concise.
  • Be respectful and considerate of others’ contributions.

📜 Code of Conduct

Please adhere to our Code of Conduct. It's important to foster an inclusive and respectful environment for everyone involved.

📄 License

This project is licensed under the MIT License. You can view the license file here.

Happy contributing! 🎉