mirror of
https://github.com/EchoVault/SugarDB.git
synced 2026-04-22 15:37:05 +08:00
Kelvin Clement Mwinuka
65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# 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. |