Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (58 loc) · 5.56 KB

CONTRIBUTING.md

File metadata and controls

89 lines (58 loc) · 5.56 KB

Contributing to Pollinations Hive - Hacktoberfest 2025 Edition

Thank you for considering contributing to the Pollinations hive project during Hacktoberfest 2025! This is a flagship project of pollinations where we allot the projects created by the users and pollinations community up for a showcase. We are thrilled to have you join our community and help us enhance this exciting project. Your contributions are vital to improving our project and expanding its capabilities.

Hacktoberfest 2025 Timeline

Hacktoberfest 2025 officially runs throughout October 2025. To have your Pull Requests (PRs) count towards your Hacktoberfest badge, they must be opened between October 1st and October 31st, 2025.

How to Contribute

We have multiple projects under the pollinations/hive umbrella, and each project has its own set of issues. To make a meaningful contribution:

1. Explore Projects and Issues

Before you start, please refer to the main README.md file of the pollinations/hive repository. It lists all the insights and provides an overview. There are dedicated issues from versatile topics under the repository Issues section.

Important for Hacktoberfest: Look for issues specifically tagged with hacktoberfest. Only PRs addressing these tagged issues will be considered for your Hacktoberfest badge. While you are welcome to resolve other issues, they will not count towards the Hacktoberfest event.

2. Understand the Issue and Build an MVP

Once you've selected an issue (especially a hacktoberfest tagged one), take the time to thoroughly understand its requirements. For code contributions, focus on building a Minimum Viable Product (MVP) that addresses the core problem or implements the key feature described in the issue.

3. Documentation Contributions

We are in profound need of members who can help enhance our documentation. If you possess experience in data science, machine learning, LLMs (Large Language Models), or Stable Diffusion, your insights will be invaluable. You can contribute by:

  • Improving existing documentation to be clearer and more comprehensive.
  • Writing new guides or tutorials that explain complex concepts or workflows.
  • Providing practical examples of how to use different features of pollinations.
  • Creating explanations for the underlying data science and ML principles.

4. Code Contributions

If you're interested in coding, we enthusiastically welcome contributions in the following areas:

  • Bug Fixes: Identifying and resolving issues that hinder the project's functionality.
  • Feature Enhancements: Adding new capabilities or improving existing ones.
  • Code Optimization: Refactoring and improving the efficiency, readability, and maintainability of the codebase.
  • New Functionalities: Developing innovative features that expand the project's scope.

How to earn the "Pollinations Contributor" badge

To earn this badge, contributors need to:

  1. Submit at least one meaningful pull request that gets merged into the repository.
  2. Ensure the pull request follows the project's contribution guidelines.
  3. The contribution can be related to bug fixes, feature additions, or documentation improvements.

Once your pull request is merged, you will automatically be issued the badge!

Getting Started

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

  2. Clone Your Fork: Clone your forked repository to your local machine. Replace your-username with your GitHub username.

    git clone https://github.com/your-username/hive.git

  3. Create a Branch for Your Work: Create a new branch for your specific contribution. It's good practice to name your branch related to the issue you're addressing (e.g., fix/bug-description or feat/new-feature-name).

    git checkout -b my-feature-branch

  4. Make Your Changes: Implement your changes, focusing on the MVP for the chosen issue.

  5. Commit Your Changes: Commit your changes with a clear and descriptive message.

    git commit -m "feat: Implement new feature for issue #XYZ"

    (Replace "XYZ" with the actual issue number)

  6. Push Your Changes: Push your local branch with your changes to your forked repository on GitHub.

    git push origin my-feature-branch

  7. Create a Pull Request (PR): Go to the original pollinations/pollinations/hive repository on GitHub. You will see an option to create a Pull Request from your recently pushed branch.

    • Crucially: Link your PR to the original issue it addresses (e.g., "Closes #XYZ" in your PR description).
    • Ensure your PR clearly explains the changes you've made and how they resolve the issue.

Guidelines

  • Follow Coding Style: Adhere to the existing coding style and conventions used within the project you are contributing to. Consistency is key!
  • Clear Commit Messages: Write clear, concise, and descriptive commit messages that explain the purpose of your changes.
  • Well-Documented Changes: Ensure your code is well-commented where necessary, and if you're making documentation contributions, strive for clarity and accuracy.
  • Test Your Changes: If applicable, write and run tests to ensure your changes work as expected and don't introduce new bugs.

Thank you for your valuable contributions during Hacktoberfest 2025! Together, we can make the pollinations/hive project a powerful and valuable resource for the community. Happy Hacking!