Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING Guidelines #119

Merged
merged 15 commits into from
May 2, 2023
Merged

Conversation

shacharPash
Copy link
Contributor

Closes #118

@shacharPash
Copy link
Contributor Author

shacharPash commented Apr 30, 2023

@chayim LMK if something is missing or needs to be removed

@codecov-commenter
Copy link

codecov-commenter commented Apr 30, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a39b818) 93.27% compared to head (3a81b0b) 93.27%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #119   +/-   ##
=======================================
  Coverage   93.27%   93.27%           
=======================================
  Files          77       77           
  Lines        4582     4582           
  Branches      424      424           
=======================================
  Hits         4274     4274           
  Misses        186      186           
  Partials      122      122           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

CONTRIBUTING.md Outdated
2. Do the changes in your fork
3. Write your tests

4. Use the `docker run -p 6379:6379 -it redis/redis-stack-server` as your local environment for running the functional tests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker run -p 6379:6379 -it redis/redis-stack-server:edge

CONTRIBUTING.md Outdated
dotnet test --filter <YourTestName>
```

If you want to run your tests against a specific host, you can do it this way:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to run your tests against a specific host and port, you can do it thus:

Copy link
Contributor

@chayim chayim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes, then ready

Copy link
Contributor

@nermiller nermiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor edits

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@chayim
Copy link
Contributor

chayim commented May 2, 2023

@shacharPash Can you take @nermiller suggestions and apply them to redis-py when done? Given that we used that as a base, it seems like some of these improvements can make it there as well.

Thanks @nermiller ❤️

shacharPash and others added 12 commits May 2, 2023 15:42
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com>
@shacharPash shacharPash merged commit 74b0076 into master May 2, 2023
@shacharPash shacharPash deleted the Issue118/ContributingGuidelines branch May 2, 2023 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING guidelines, like other clients
4 participants