diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..e38f45c4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,80 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project +and our community a harassment-free experience for everyone, regardless +of age, body size, 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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual + attention or advances +- Trolling, insulting/derogatory comments, and personal or political + attacks +- Public or private harassment +- Publishing others' private information, such as a physical or + electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in + a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of +acceptable behavior and are expected to take appropriate and fair +corrective action in response to any instances of unacceptable behavior. + +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 to this Code of Conduct, or to ban +temporarily or permanently any contributor for other behaviors that they +deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also +applies when an individual is representing the project or its community +in public spaces. Examples of representing a project or community +include using an official project e-mail address, posting via an +official social media account, or acting as an appointed representative +at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may +be reported by contacting the project team at . +All complaints will be reviewed and investigated and will result in a +response that is deemed necessary and appropriate to the circumstances. +The project team is obligated to maintain confidentiality with regard to +the reporter of an incident. Further details of specific enforcement +policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in +good faith may face temporary or permanent repercussions as determined +by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor +Covenant](https://www.contributor-covenant.org), version 1.4, available +at + + +For answers to common questions about this code of conduct, see + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ab2becd3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# Contributing + +## Issues + +Issues are very valuable to this project. + +- Ideas are a valuable source of contributions others can make +- Problems show where this project is lacking +- With a question you show where contributors can improve the user + experience + +Thank you for creating them. + +## Pull Requests + +Pull requests are a great way to get your ideas into this repository. + +Before opening a pull request, reach out to one of the organization +members or state your intent in the [discord server](https://discord.com/invite/JrG4kPrF8v). This prevents you +from potentially doing redundant or low-priority work. + +When deciding if I merge in a pull request I look at the following +things: + +### Does it state intent + +You should be clear which problem you're trying to solve with your +contribution. + +For example: + +> Add link to code of conduct in README.md + +Doesn't tell me anything about why you're doing that + +> Add link to code of conduct in README.md because users don't always +> look in the CONTRIBUTING.md + +Tells me the problem that you have found, and the pull request shows me +the action you have taken to solve it. + +### Is it of good quality + +- There are no spelling mistakes +- It reads well +- For english language contributions: Has a good score on + [Grammarly](https://www.grammarly.com) or [Hemingway + App](https://www.hemingwayapp.com/) + +### Does it move this repository closer to my vision for the repository + +The aim of this repository is: + +- To provide a distributed (primarily) in-memory data cache that is + embeddable in Go and compatible with RESP. +- Foster a culture of respect and gratitude in the open source + community. + +### Does it follow the contributor covenant + +This repository has a [code of conduct](CODE_OF_CONDUCT.md), I will +remove things that do not respect it. + +If all the above conditions are met, feel free to fork the project +and open a pull request. \ No newline at end of file