Skip to content

Commit bb1a1a2

Browse files
yaxingadam-fowler
andauthored
Add CONTRIBUTING.md with instructions for contributions
* Add CONTRIBUTING.md with basic instructions for contributions Signed-off-by: Yaxing Chen <[email protected]> * Update CONTRIBUTING.md with instructions Signed-off-by: Yaxing Chen <[email protected]> * Addressing PR comments: - Fixed license from BSD to Apache 2.0 - Added DCO information - Removed unnecessary detailed git instructions - Reused Hummingbird contributing instructions for bug/issue and PR - Added formatting - Added code of conduct Signed-off-by: Yaxing Chen <[email protected]> * Fixing typo Co-authored-by: Adam Fowler <[email protected]> Signed-off-by: Yaxing Chen <[email protected]> * Fixing wrong project name in the description Co-authored-by: Adam Fowler <[email protected]> Signed-off-by: Yaxing Chen <[email protected]> --------- Signed-off-by: Yaxing Chen <[email protected]> Co-authored-by: Adam Fowler <[email protected]>
1 parent 4694322 commit bb1a1a2

File tree

2 files changed

+115
-0
lines changed

2 files changed

+115
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Code of Conduct
2+
3+
All developers should feel welcome and encouraged to contribute to valkey-swift. Because of this we have adopted the code of conduct defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
4+
communities, and we think it articulates our values well. The full text is copied below:
5+
6+
## Contributor Code of Conduct v1.3
7+
8+
As contributors and maintainers of this project, and in the interest of
9+
fostering an open and welcoming community, we pledge to respect all people who
10+
contribute through reporting issues, posting feature requests, updating
11+
documentation, submitting pull requests or patches, and other activities.
12+
13+
We are committed to making participation in this project a harassment-free
14+
experience for everyone, regardless of level of experience, gender, gender
15+
identity and expression, sexual orientation, disability, personal appearance,
16+
body size, race, ethnicity, age, religion, or nationality.
17+
18+
Examples of unacceptable behavior by participants include:
19+
20+
* The use of sexualized language or imagery
21+
* Personal attacks
22+
* Trolling or insulting/derogatory comments
23+
* Public or private harassment
24+
* Publishing other's private information, such as physical or electronic
25+
addresses, without explicit permission
26+
* Other unethical or unprofessional conduct
27+
28+
Project maintainers have the right and responsibility to remove, edit, or
29+
reject comments, commits, code, wiki edits, issues, and other contributions
30+
that are not aligned to this Code of Conduct, or to ban temporarily or
31+
permanently any contributor for other behaviors that they deem inappropriate,
32+
threatening, offensive, or harmful.
33+
34+
By adopting this Code of Conduct, project maintainers commit themselves to
35+
fairly and consistently applying these principles to every aspect of managing
36+
this project. Project maintainers who do not follow or enforce the Code of
37+
Conduct may be permanently removed from the project team.
38+
39+
This Code of Conduct applies both within project spaces and in public spaces
40+
when an individual is representing the project or its community.
41+
42+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
43+
reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All
44+
complaints will be reviewed and investigated and will result in a response that
45+
is deemed necessary and appropriate to the circumstances. Maintainers are
46+
obligated to maintain confidentiality with regard to the reporter of an
47+
incident.
48+
49+
50+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
51+
version 1.3.0, available at https://www.contributor-covenant.org/version/1/3/0/code-of-conduct.html
52+
53+
[homepage]: https://www.contributor-covenant.org
54+

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to Valkey Swift
2+
3+
Thanks for your interest in contributing to Valkey Swift — the Swift client library for Valkey!
4+
We appreciate all contributions — whether it’s fixing bugs, improving documentation, or adding features.
5+
6+
## Legal
7+
By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch
8+
that your contributions are licensed under the Apache 2.0 license (see [LICENSE](LICENSE)).
9+
10+
## Developer Certificate of Origin
11+
12+
We respect the intellectual property rights of others and we want to make sure
13+
all incoming contributions are correctly attributed and licensed. A Developer
14+
Certificate of Origin (DCO) is a lightweight mechanism to do that. The DCO is
15+
a declaration attached to every commit. In the commit message of the contribution,
16+
the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO,
17+
which you can find at [DeveloperCertificate.org](http://developercertificate.org/).
18+
19+
We require that every contribution to Valkey Swift to be signed with a DCO. We require the
20+
usage of known identity (such as a real or preferred name). We do not accept anonymous
21+
contributors nor those utilizing pseudonyms. A DCO signed commit will contain a line like:
22+
23+
```text
24+
Signed-off-by: Jane Smith <[email protected]>
25+
```
26+
27+
You may type this line on your own when writing your commit messages. However, if your
28+
user.name and user.email are set in your git configs, you can use `git commit` with `-s`
29+
or `--signoff` to add the `Signed-off-by` line to the end of the commit message. We also
30+
require revert commits to include a DCO.
31+
32+
If you're contributing code to the Valkey Swift project in any other form, including
33+
sending a code fragment or patch via private email or public discussion groups,
34+
you need to ensure that the contribution is in accordance with the DCO.
35+
36+
## Contributor Conduct
37+
All contributors are expected to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md).
38+
39+
## Submitting a bug or issue
40+
41+
Please ensure to include the following in your bug report
42+
- A concise description of the issue, what happened and what you expected.
43+
- Simple reproduction steps
44+
- Version of the library you are using
45+
- Contextual information (Swift version, OS version, Valkey version, etc)
46+
47+
## Submitting a Pull Request
48+
49+
Please ensure to include the following in your Pull Request
50+
- A description of what you are trying to do. What the PR provides to the library, additional functionality, fixing a bug etc
51+
- A description of the code changes
52+
- Documentation on how these changes are being tested
53+
- Additional tests to show your code working and to ensure future changes don't break your code.
54+
55+
Please keep your PRs to a minimal number of changes. If a PR is large try to split it up into smaller PRs. Don't move code around unnecessarily it makes comparing old with new very hard.
56+
57+
The main development branch of the repository is `main`.
58+
59+
## Formatting
60+
61+
We use [Apple's swift-format](https://github.com/swiftlang/swift-format) for formatting code. PRs will not be accepted if they haven't be formatted.

0 commit comments

Comments
 (0)