Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 2.37 KB
Raw

Contribution Guidelines 📚

Welcome to Our Project! Thank you for your interest in contributing! Please read the following guidelines carefully to ensure smooth collaboration.

General Guidelines:

Creativity Allowed: If you have an idea that bends the rules, feel free to submit a pull request (PR). We may still merge it! No Build Steps: Please avoid adding build steps (e.g., npm install). This project is intended to stay simple as a static site. Preserve Existing Content: Ensure you do not remove any existing content. Code Style: Whether your code is clean or messy, simple or complex—it’s all welcome, as long as it works. Add Your Name: Don’t forget to add your name to the contributorsList file. Keep it Small: Try to keep your pull requests small. This helps minimize merge conflicts and makes reviews easier.

Getting Started 🤩🤗

  1. Fork the Repository:
  • Click the "Fork" button at the top right of the repository page to create your own copy of the project.

  1. Clone Your Fork:

    • Clone the forked repository to your local machine.
     git clone https://github.com/your-username/Hacktoberfest2024.git

  2. Navigate to the Project Directory:

     cd Hacktoberfest2024
    1. Create a New Branch:
    git checkout -b my-new-branch

  3. Make Your Changes:

    • Add your name to contributors/contributorsList.js and make any other contributions.
    git add .

  4. Commit Your Changes:

    git commit -m "Relevant message"

  5. Push to Your Branch:

    git push origin my-new-branch

  6. Create a Pull Request:

    • Go to your forked repository on GitHub and create a pull request to the main repository.

  7. Add Upstream Remote:

    git remote add upstream https://github.com/fineanmol/Hacktoberfest2024

  8. Verify the New Remote:

    git remote -v

  9. Sync Your Fork with Upstream:

    git fetch upstream
git merge upstream/master

    This will pull in changes from the parent repository and help you resolve any conflicts.

  10. Stay Updated:

    • Regularly pull changes from the upstream repository to keep your fork updated.

We appreciate your contributions and are excited to have you as part of our community! Thank you for helping improve our project!