Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (45 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

74 lines (45 loc) · 2.22 KB
Raw

Contributing to Hacktoberfest-2023

Welcome to Hacktoberfest-2023! We appreciate your interest in contributing to our project. To ensure a smooth contribution process, please follow the guidelines below.

Hacktoberfest

Hacktoberfest-2023 is excited to be a part of Hacktoberfest, a month-long celebration of open source software. By contributing to this project, you can earn cool swag and make valuable contributions to the open source community.

Contribution Rules📚:

  • You are allowed to make pull requests that break the rules. We just merge it ;)
  • Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
  • Do NOT remove other content.
  • Styling/code can be pretty, ugly or stupid, big or small as long as it works
  • Add your name to the contributorsList file
  • Try to keep pull requests small to minimize merge conflicts

Getting Started

  1. Fork the repository:

    • Fork the repository to your GitHub account.

  2. Clone the repository:

    • Clone the forked repository to your local machine using the following command:
    git clone https://github.com/chetanbhasney02/Hacktoberfest-2023.git

  3. Create a new branch:

    • Create a new branch for your changes.
    git checkout -b my-feature

  4. Install dependencies:

    • Navigate to the project folder and install dependencies.
      npm install  # or any other necessary command

  5. Make changes:

    • Make your contributions. Whether it's fixing a bug, adding a feature, or improving documentation, every contribution is valuable.

  6. Run tests:

    • Ensure your changes pass any existing tests.
      npm test  # or any other necessary command

  7. Commit your changes:

    • Commit your changes with a clear and concise message.
      git commit -m "Description of your changes"

  8. Push your changes:

    • Push your changes to your fork.
      git push origin my-feature

What Can I Contribute?:

  • Bug Fixes: Help us squash those bugs!
  • Features: Add new functionalities.
  • Documentation: Improve documentation for better understanding.
  • Tests: Contribute test cases to ensure code reliability.