Skip to content

Commit bdf044a

Browse files
tobi-laatobi-laa
committed
GitHub community standard
1 parent 7fcba71 commit bdf044a

File tree

6 files changed

+252
-0
lines changed

6 files changed

+252
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help this project improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
1. Set up a test using embedded Redis as follows '....'
17+
2. See erroneous or unexpected behavior '....'
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen or how you expected the tests to be executed.
21+
22+
**Minimal example**
23+
Ideally, provide a minimal example to reproduce the described error.
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen. Ideally provide the source code of a test class with some
15+
test methods that would demonstrate the desired behavior.
16+
17+
**Describe alternatives you've considered**
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Add a meaningful description of the changes introduced by this pull request. Ideally reference one or several issues
2+
related and/or fixed by the pull request.
3+
4+
---
5+
6+
- [ ] All commit messages contain meaningful descriptions.
7+
- [ ] All public methods, classes and interfaces have meaningful KDoc.
8+
- [ ] Further documentation has been added to `README.adoc` where applicable.
9+
- [ ] Tests have been added covering the changes being made. Depending on the change this might entail unit tests,
10+
integration tests or both.
11+
- [ ] Build pipeline passes.

‎CODE_OF_CONDUCT.md

+128
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+
[email protected].
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+
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.adoc

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= Contributing to `spring-boot-embedded-redis`
2+
3+
`spring-boot-embedded-redis` is released under the Apache 2.0 license.
4+
Read on if you would like to contribute!
5+
6+
== Code of Conduct
7+
8+
This project adheres to the Contributor Covenant xref:CODE_OF_CONDUCT.adoc[code of conduct].
9+
By participating, you are expected to uphold this code.
10+
11+
== Using GitHub Issues
12+
13+
This project uses GitHub issues to track bugs and enhancements.
14+
Please check the following before opening an issue:
15+
16+
* your issue is not a duplicate/is not already addressed by another issue
17+
* your issue affects the latest available release
18+
19+
== Code Conventions and Housekeeping
20+
21+
None of these is essential for a pull request, but they will all help.
22+
They can also be added after the original pull request but before a merge.
23+
24+
* Please add meaningful descriptions to all commit messages.
25+
Furthermore, try to keep single commits from getting too large.
26+
* Please add meaningful KDoc to all public methods, classes and interfaces.
27+
* If you feel it might make sense to do so, add further documentation to `README.adoc`.
28+
* Add tests covering the changes being made.
29+
Depending on the change this might entail unit tests, integration tests or both.
30+
This project breaks at less than 100% code coverage, so this is a must.
31+
* Keep your feature branch up-to-date with `main`.
32+
33+
== Building from Source
34+
35+
The project can be built from the root directory using:
36+
37+
[,bash]
38+
----
39+
gradle clean build
40+
----
41+
42+
== Releases
43+
44+
Releases are automatically built and published to Maven Central once a tag following the semantic versioning pattern is pushed (i.e. `v1.0.0`).
45+
46+
The artifact version should correspond to the aforementioned tag, meaning tags such as `v1.0.0` should only be applied if the artifact version within the project's `build.gradle.kts` is `1.0.0`.
47+
48+
TODO: Gradle Release plugin
49+
50+
[,bash]
51+
----
52+
mvn release:prepare release:clean -B
53+
----

‎SECURITY.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|--------------------|
7+
| `1.0.x` | :white_check_mark: |
8+
9+
## Reporting a Vulnerability
10+
11+
Please send a [mail](mailto:[email protected]) describing the vulnerability.
12+
If you have the means and will to, feel free to prepare a branch containing the
13+
security update within you _local_ repository and get in touch about having it merged.

0 commit comments

Comments
 (0)