Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 72a5dd9

Browse files
authored
Add License and Community Health Files (#3)
1 parent d0c1546 commit 72a5dd9

File tree

6 files changed

+176
-3
lines changed

6 files changed

+176
-3
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/), and this
6+
project adheres to [Semantic Versioning](https://semver.org/).
7+
8+
## [Unreleased]
9+
10+
[Unreleased]: https://github.com/Fleshgrinder/kotlin-uuid

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
Thanks for considering helping us out. ❤️
3+
4+
When contributing to this repository, please first discuss the change you wish
5+
to make via a [issue] before making a change. Do not create an issue if you
6+
only have a question, instead use our [support].
7+
8+
Please note we have a [Code of Conduct], please follow it in all your
9+
interactions with the project.
10+
11+
## Pull Request Process
12+
1. Follow the official [Kotlin Coding Conventions], especially the
13+
[coding conventions for libraries].
14+
1. Update the [CHANGELOG] according to the rules of [Keep a Changelog].
15+
1. Update the [README] if applicable.
16+
1. [Sign your commits] to accept the [license] and ensure auditability.
17+
18+
[issue]: https://github.com/Fleshgrinder/kotlin-uuid/issues
19+
[support]: ./SUPPORT.md
20+
[Code of Conduct]: ./CODE_OF_CONDUCT.md
21+
[Kotlin Coding Conventions]: https://kotlinlang.org/docs/reference/coding-conventions.html
22+
[coding conventions for libraries]: https://kotlinlang.org/docs/reference/coding-conventions.html#coding-conventions-for-libraries
23+
[CHANGELOG]: ./CHANGELOG.md
24+
[Keep a Changelog]: https://keepachangelog.com/
25+
[README]: ./README.md
26+
[Sign your commits]: https://help.github.com/en/github/authenticating-to-github/signing-commits
27+
[license]: ./UNLICENSE.md

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
# Kotlin UUID
2-
Multiplatform, RFC-compliant, and fast UUID implementation for Kotlin. The goal
3-
of this project is to become part of the stdlib. Hence, there are no releases
4-
that you could use other than directly including the source in your project.
2+
Fast, idiomatic, and RFC compliant multi-platform Kotlin library for UUIDs.

SUPPORT.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Support
2+
1. Use [Slack] for questions regarding the usage of this library.
3+
1. Use [StackOverflow] for questions regarding UUIDs in general.
4+
1. Create an [issue] if you found a bug, security issue, or have a feature
5+
request.
6+
7+
[Slack]: https://kotlinlang.slack.com/messages/uuid
8+
[StackOverflow]: https://stackoverflow.com/
9+
[issue]: https://github.com/Fleshgrinder/kotlin-uuid/issues

UNLICENSE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Unlicense
2+
This is free and unencumbered software released into the public domain.
3+
4+
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
5+
software, either in source code form or as a compiled binary, for any purpose,
6+
commercial or non-commercial, and by any means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors of this
9+
software dedicate any and all copyright interest in the software to the public
10+
domain. We make this dedication for the benefit of the public at large and to
11+
the detriment of our heirs and successors. We intend this dedication to be an
12+
overt act of relinquishment in perpetuity of all present and future rights to
13+
this software under copyright law.
14+
15+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19+
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
22+
For more information, please refer to [unlicense.org](http://unlicense.org/).

0 commit comments

Comments
 (0)