Skip to content

Commit b31560a

Browse files
Merge pull request #162 from pollinations/hb-fest
added the contributing + code of conduct + revamped readme to adapt t…
2 parents ae5c272 + 9cc1d73 commit b31560a

3 files changed

Lines changed: 224 additions & 1 deletion

File tree

CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
ayushbhatt633@gmail.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
Poll_EC53MY42FN5NTX3JQNJJIY3LE7U
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to Pollinations Hive - Hacktoberfest 2025 Edition
2+
3+
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.
4+
5+
## Hacktoberfest 2025 Timeline
6+
7+
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**.
8+
9+
## How to Contribute
10+
11+
We have multiple projects under the `pollinations/hive` umbrella, and each project has its own set of issues. To make a meaningful contribution:
12+
13+
14+
### 1. Explore Projects and Issues
15+
16+
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](https://github.com/pollinations/hive/issues) section.
17+
18+
**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.
19+
20+
### 2. Understand the Issue and Build an MVP
21+
22+
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.
23+
24+
### 3. Documentation Contributions
25+
26+
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:
27+
28+
- Improving existing documentation to be clearer and more comprehensive.
29+
- Writing new guides or tutorials that explain complex concepts or workflows.
30+
- Providing practical examples of how to use different features of pollinations.
31+
- Creating explanations for the underlying data science and ML principles.
32+
33+
### 4. Code Contributions
34+
35+
If you're interested in coding, we enthusiastically welcome contributions in the following areas:
36+
37+
- **Bug Fixes:** Identifying and resolving issues that hinder the project's functionality.
38+
- **Feature Enhancements:** Adding new capabilities or improving existing ones.
39+
- **Code Optimization:** Refactoring and improving the efficiency, readability, and maintainability of the codebase.
40+
- **New Functionalities:** Developing innovative features that expand the project's scope.
41+
42+
### How to earn the "Pollinations Contributor" badge
43+
To earn this badge, contributors need to:
44+
1. Submit at least one meaningful pull request that gets merged into the repository.
45+
2. Ensure the pull request follows the project's contribution guidelines.
46+
3. The contribution can be related to bug fixes, feature additions, or documentation improvements.
47+
48+
Once your pull request is merged, you will automatically be issued the badge!
49+
50+
51+
## Getting Started
52+
53+
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.
54+
55+
2. **Clone Your Fork**: Clone your forked repository to your local machine. Replace `your-username` with your GitHub username.
56+
```bash
57+
git clone https://github.com/your-username/hive.git
58+
```
59+
60+
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`).
61+
```bash
62+
git checkout -b my-feature-branch
63+
```
64+
65+
4. **Make Your Changes**: Implement your changes, focusing on the MVP for the chosen issue.
66+
67+
5. **Commit Your Changes**: Commit your changes with a clear and descriptive message.
68+
```bash
69+
git commit -m "feat: Implement new feature for issue #XYZ"
70+
```
71+
(Replace "XYZ" with the actual issue number)
72+
73+
6. **Push Your Changes**: Push your local branch with your changes to your forked repository on GitHub.
74+
```bash
75+
git push origin my-feature-branch
76+
```
77+
78+
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.
79+
* **Crucially:** Link your PR to the original issue it addresses (e.g., "Closes #XYZ" in your PR description).
80+
* Ensure your PR clearly explains the changes you've made and how they resolve the issue.
81+
82+
## Guidelines
83+
84+
- **Follow Coding Style:** Adhere to the existing coding style and conventions used within the project you are contributing to. Consistency is key!
85+
- **Clear Commit Messages:** Write clear, concise, and descriptive commit messages that explain the purpose of your changes.
86+
- **Well-Documented Changes:** Ensure your code is well-commented where necessary, and if you're making documentation contributions, strive for clarity and accuracy.
87+
- **Test Your Changes:** If applicable, write and run tests to ensure your changes work as expected and don't introduce new bugs.
88+
89+
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!

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# 🐝 Pollinations Hive
2-
<!-- Placeholder for deployment simplification changes -->
2+
33

44
Welcome to Pollinations Hive - a revolutionary repository where AI meets collaborative development! This project showcases a unique approach to software development where applications are created and modified entirely through AI assistance.
55

6+
## 📢 Hacktoberfest News
7+
8+
- **Hacktoberfest 2025 is here!**
9+
If you're participating, please check out our [Code of Conduct](./CODE_OF_CONDUCT.md) and [Contributing Guidelines](./CONTRIBUTING.md) before submitting your PRs.
10+
- For event PRs, look for issues tagged with `hacktoberfest` in our [issue tracker](https://github.com/pollinations/hive/issues) and join the community effort!
11+
612
## 📱 Available Apps
713

814
| App | Source | Last Updated |

0 commit comments

Comments
 (0)