Skip to content

Commit 78cb30d

Browse files
author
imash
committed
docs: rewrite documentation for hackathon submission
- Completely rewrote README.md (574 lines) - professional and concise - Reduced CONTRIBUTING.md to 282 lines - removed redundant content - Updated CODE_OF_CONDUCT.md, SECURITY.md for consistency - Changed LICENSE to MIT License (2025 copyright) - Removed all unnecessary hackathon-specific files - Focused on project essentials and meaningful content
1 parent 070d1b5 commit 78cb30d

File tree

5 files changed

+1185
-899
lines changed

5 files changed

+1185
-899
lines changed

CODE_OF_CONDUCT.md

Lines changed: 120 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,162 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of Conduct
22

33
## Our Pledge
44

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.
5+
We as members, contributors, and leaders pledge to make participation in the MariaDB Vector Store integration project a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
116

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
148

159
## Our Standards
1610

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
11+
### Examples of Positive Behavior
1912

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
13+
Behaviors that contribute to a positive environment include:
2714

28-
Examples of unacceptable behavior include:
15+
- Demonstrating empathy and kindness toward other people
16+
- Being respectful of differing opinions, viewpoints, and experiences
17+
- Giving and gracefully accepting constructive feedback
18+
- Accepting responsibility and apologizing to those affected by our mistakes
19+
- Learning from the experience and making improvements
20+
- Focusing on what is best not just for us as individuals, but for the overall community
21+
- Using welcoming and inclusive language
22+
- Being patient with newcomers and those learning
23+
- Providing helpful and constructive code reviews
24+
- Celebrating others' successes and contributions
2925

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
26+
### Examples of Unacceptable Behavior
27+
28+
Behaviors that are unacceptable include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
31+
- Trolling, insulting or derogatory comments, and personal or political attacks
32+
- Public or private harassment
33+
- Publishing others' private information, such as a physical or email address, without their explicit permission
34+
- Deliberately intimidating, stalking, or following
35+
- Harassing photography or recording
36+
- Sustained disruption of discussions or other events
37+
- Inappropriate physical contact or unwelcome sexual attention
38+
- Other conduct which could reasonably be considered inappropriate in a professional setting
39+
- Advocating for, or encouraging, any of the above behaviors
3840

3941
## Enforcement Responsibilities
4042

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.
43+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
4544

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.
45+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
5046

5147
## Scope
5248

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.
49+
This Code of Conduct applies within all project spaces, and also applies when an individual is officially representing the project in public spaces. Examples of representing our project include:
50+
51+
- Using an official project email address
52+
- Posting via an official social media account
53+
- Acting as an appointed representative at an online or offline event
54+
- Contributing code, documentation, or other materials
55+
- Participating in project discussions on GitHub, forums, or chat platforms
56+
- Representing the project at hackathons or conferences
5857

5958
## Enforcement
6059

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
[Moderator Email](mailto:samarpatel.mi@gmail.com).
60+
### Reporting
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers responsible for enforcement through:
63+
64+
- **GitHub Issues:** For public concerns about project conduct
65+
- **MindSQL Repository:** Through the main project's reporting channels
66+
- **Hackathon Organizers:** For issues during the MariaDB Python Hackathon
67+
6468
All complaints will be reviewed and investigated promptly and fairly.
6569

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
70+
All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
71+
72+
### Enforcement Guidelines
73+
74+
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
75+
76+
#### 1. Correction
77+
78+
**Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
79+
80+
**Consequence:** A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
81+
82+
#### 2. Warning
6883

69-
## Enforcement Guidelines
84+
**Community Impact:** A violation through a single incident or series of actions.
7085

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:
86+
**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in project spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
7387

74-
### 1. Correction
88+
#### 3. Temporary Ban
7589

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
90+
**Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
7891

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.
92+
**Consequence:** A temporary ban from any sort of interaction or public communication with the project for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
8293

83-
### 2. Warning
94+
#### 4. Permanent Ban
8495

85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
96+
**Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
8797

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.
98+
**Consequence:** A permanent ban from any sort of public interaction within the project community.
9499

95-
### 3. Temporary Ban
100+
## Technical Conduct
96101

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
102+
In addition to general community standards, we expect all contributors to follow these technical conduct guidelines:
99103

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.
104+
### Code Review
105105

106-
### 4. Permanent Ban
106+
- Provide constructive, specific, and actionable feedback
107+
- Focus on the code, not the person
108+
- Be patient with less experienced contributors
109+
- Explain the "why" behind suggestions
110+
- Acknowledge good practices and clever solutions
107111

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.
112+
### Collaboration
111113

112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
114+
- Communicate clearly and respectfully
115+
- Be open to different approaches and solutions
116+
- Document your code and decisions
117+
- Help others learn and grow
118+
- Share knowledge generously
119+
120+
### Quality Standards
121+
122+
- Write clean, maintainable code
123+
- Follow project coding standards
124+
- Include appropriate tests
125+
- Document public APIs
126+
- Respect existing architectural decisions
127+
128+
### Issue Reporting
129+
130+
- Search for existing issues before creating new ones
131+
- Provide detailed reproduction steps
132+
- Include relevant environment information
133+
- Be respectful of maintainer time
134+
- Follow issue templates when provided
114135

115136
## Attribution
116137

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.
138+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
139+
140+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
141+
142+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
143+
144+
## Questions
145+
146+
If you have questions about this Code of Conduct, please:
147+
148+
- Review the [Contributor Covenant FAQ](https://www.contributor-covenant.org/faq)
149+
- Open a discussion in the project repository
150+
- Contact the project maintainers
151+
152+
## Commitment
153+
154+
We are committed to providing a welcoming and inspiring community for all. We expect all community members to follow this Code of Conduct in all project interactions.
155+
156+
Thank you for helping make this a welcoming, friendly community for everyone.
120157

121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
158+
---
123159

124-
[homepage]: https://www.contributor-covenant.org
160+
**Last Updated:** October 31, 2024
161+
**Version:** 1.0.0
125162

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.

0 commit comments

Comments
 (0)