Skip to content

Commit

Permalink
Fixed CONTRIBUTING, expended bug-repot.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
barshaul committed Nov 23, 2023
1 parent 1836f4e commit 42dc1b1
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 12 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ body:
description: What is the problem? A clear and concise description of the bug.
validations:
required: true

- type: textarea
id: expected
attributes:
Expand All @@ -20,6 +21,7 @@ body:
What did you expect to happen?
validations:
required: true

- type: textarea
id: current
attributes:
Expand All @@ -31,6 +33,7 @@ body:
If service responses are relevant, please include wire logs.
validations:
required: true

- type: textarea
id: reproduction
attributes:
Expand All @@ -43,6 +46,7 @@ body:
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
validations:
required: true

- type: textarea
id: solution
attributes:
Expand All @@ -51,6 +55,7 @@ body:
Suggest a fix/reason for the bug
validations:
required: false

- type: textarea
id: context
attributes:
Expand All @@ -60,6 +65,21 @@ body:
validations:
required: false

- type: input
id: client-version
attributes:
label: Client version used
validations:
required: true

- type: input
id: redis-version
attributes:
label: Redis Version
description: E.g. 6.2, 7.0
validations:
required: true

- type: input
id: operating-system
attributes:
Expand All @@ -83,6 +103,24 @@ body:
attributes:
label: Language Version
description: E.g. TypeScript (5.2.2) | Python (3.9)
validations:
required: true

- type: textarea
id: cluster-info
attributes:
label: Cluster information
description: |
Redis cluster information, cluster topology, number of shards, number of replicas, used data types.
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs
description: |
Client and/or Redis logs.
validations:
required: false

Expand Down
15 changes: 3 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,21 @@ information to effectively respond to your bug report or contribution.
We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of our code being used
* Operating system
* Redis version
* Redis cluster information, cluster topology, number of shards, number of replicas, used data types
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment
* logs
reported the issue. Please try to include as much information as you can.

## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *main* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3. You open an issue to discuss any significant changes before starting the work - we would hate for your time to be wasted.

To send us a pull request, please:

1. Fork the repository.
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
4. Commit to your fork using clear commit messages, merge or squash commits as necessary.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

Expand Down

0 comments on commit 42dc1b1

Please sign in to comment.