1
0
Fork 0
mirror of https://github.com/dragonflydb/dragonfly.git synced 2024-12-14 11:58:02 +00:00

feat(community): Add Conventional Commits; Code of Conduct #107 (#133)

* docs(community): Add Code of Conduct #107

Signed-off-by: Ryan Russell <git@ryanrussell.org>

* feat(pre-commit): Add Conventional Commits `commit-msg` hook #107

Signed-off-by: Ryan Russell <git@ryanrussell.org>

* bug(pre-commit): Fix conventional commits entry to include `contrib/scripts` #107

Signed-off-by: Ryan Russell <git@ryanrussell.org>
This commit is contained in:
Ryan Russell 2022-06-12 00:21:40 -05:00 committed by GitHub
parent ff632b1c4b
commit a29b66068c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 289 additions and 0 deletions

8
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,8 @@
repos:
- repo: local
hooks:
- id: conventional-commits
name: Conventional Commit Minder
entry: contrib/scripts/conventional-commits
language: script
stages: [commit-msg]

7
.pre-commit-hooks.yaml Normal file
View file

@ -0,0 +1,7 @@
- id: conventional-commits
name: Conventional Commits Minder
entry: contrib/scripts/conventional-commits
language: script
description: Conventional Commits Enforcement at the `git commit` client-side level
always_run: true
stages: [commit-msg]

128
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community 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, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders 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.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
https://github.com/dragonflydb/dragonfly/discussions.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**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 community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community 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.
### 4. Permanent Ban
**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.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

75
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,75 @@
# Contributing to Dragonfly DB
Thank you for your interest in Dragonfly DB.
Feel free to browse our [Discussions](https://github.com/dragonflydb/dragonfly/discussions) and [Issues](https://github.com/dragonflydb/dragonfly/issues)
# Best Practices
# Signoff Commits
All community submissions must include a signoff.
```bash
git commit -s -m '...'
```
# Squash Commits
Please squash all commits for a change into a single commit (this can be done using "git rebase -i"). Do your best to have a well-formed commit message for the change.
# Use Conventional Commits
This repo uses [Conventional Commmits](https://www.conventionalcommits.org/en/v1.0.0/)
The Conventional Commits specification is a lightweight convention on top of commit messages.
It provides an easy set of rules for creating an explicit commit history;
which makes it easier to write automated tools on top of.
This convention dovetails with [SemVer](http://semver.org),
by describing the features, fixes, and breaking changes made in commit messages.
The commit message should be structured as follows:
---
```
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
```
---
This repo uses automated tools to standardize the formatting of code, text files and commits.
- [Pre-commit hooks](#pre-commit-hooks) validate and automatically apply code
formatting rules.
# `pre-commit` hooks
The Dragonfly DB team has agreed to systematically use a number of pre-commit hooks to
normalize formatting of code. You need to install and enable pre-commit to have these used
when you do your own commits.
## Fork and Clone the DragonflyDB repository
```
# Fork https://github.com/dragonflydb/dragonfly
# Clone from your fork
git@github.com:<YOURUSERNAME>/dragonfly.git
cd dragonfly
# IMPORTANT! Enable our pre-commit message hooks
# This will ensure your commits match our formatting requirements
pre-commit install --hook-type commit-msg
```
This step must be done on each machine you wish to develop and contribute from to activate the `commit-msg` hook client-side.
Once you have done these things, we look forward to adding your contributions and improvements to the Dragonfly DB project.
## License terms for contributions
This Project welcomes contributions, suggestions, and feedback. Dragonfly uses the BSL license. You represent that if you do not own copyright in the code that you have the authority to submit it under the BSL. All feedback, suggestions, or contributions are not confidential.
## THANK YOU FOR YOUR CONTRIBUTIONS

View file

@ -0,0 +1,71 @@
#!/usr/bin/env bash
# list of Conventional Commits types
cc_types=("feat" "fix")
default_types=("build" "chore" "ci" "docs" "${cc_types[@]}" "perf" "refactor" "revert" "style" "test")
types=( "${cc_types[@]}" )
if [ $# -eq 1 ]; then
types=( "${default_types[@]}" )
else
while [ $# -gt 1 ]; do
types+=( "$1" )
shift
done
fi
msg_file="$1"
r_types="($(IFS='|'; echo "${types[*]}"))"
r_scope="(\([[:alnum:] \/-]+\))?"
r_delim='!?:'
r_subject=" [[:print:]].+"
pattern="^$r_types$r_scope$r_delim$r_subject$"
if grep -Eq "$pattern" "$msg_file"; then
exit 0
fi
echo "[Commit message] $( cat "$msg_file" )"
echo "
Thank you for your interest in Dragonfly DB.
To keep things clean, we ask all commits to meet the following criteria:
- Be Signed (git commit -s -m ...)
- Valid Conventional Commit https://www.conventionalcommits.org/
Special Commit Words are correlated to versioning. Specifically \"fix\" and \"feat\"
- fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
- feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
- Breaking changes have a ! before the \":\"
Finally, If there is an Issue for this Commit, Please add it to the end of the commit message.
- Reference Issue Number at End of Commit Message (Optional)
Thank you for helping us label a \`fix\` and \`feat\` properly so that our commits, issues and semantic versioning are all aligned!
A Signed Conventional Commit with Issue Number look like:
git commit -s -m \"type(scope): description #112\"
Valid types:
$(IFS=' '; echo "${types[*]}")
Example Document Change:
docs(readme): Fix Example Links #121
Example Breaking New Feature
feat(ingest)!: Add new ingest # 122
This is an example of a fix with an Issue #
fix(ingest): Refactor for loop to list comprehension #123
Thank you for your contribution!
Sincerely,
The Dragonfly DB Contributors
"
exit 1