Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.46 KB
Raw

Contributing to Hacktoberfest-2023

Welcome to Hacktoberfest-2023! We're delighted to have you interested in contributing to our project. To ensure a seamless contribution process, please follow the guidelines below.

Hacktoberfest

Hacktoberfest-2023 is proudly participating in Hacktoberfest, a month-long celebration of open source software. By contributing here, you can earn cool swag and make valuable contributions to the open source community.

Contribution Rules 📚:

  • Pull requests that break the rules are allowed; we'll merge them anyway ;)
  • Do NOT add any build steps (e.g., npm install); let's keep this a simple static site.
  • Do NOT remove other content.
  • Styling and code can be pretty, ugly, or even silly, as long as it works.
  • Don't forget to 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/StepJes/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?

Here are some ways you can contribute to our project:

  • Bug Fixes: Help us identify and fix issues to ensure a smoother user experience.
  • Features: Add new functionalities to enhance the project's capabilities.
  • Documentation: Improve the existing documentation or create new guides for better understanding.
  • Tests: Contribute test cases to verify the reliability and stability of the codebase.