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.

Sign up for GitHub

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

Jump to bottom

doc: document that users can self-assign issues #712

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

doc: document that users can self-assign issues #712

wants to merge 3 commits into from
+9 −1

Conversation

KentHsu
Copy link
Contributor

@KentHsu KentHsu commented May 14, 2024

Description

Refer to js-sdk, informs users about the GitHub daprbot commands available in the repo with doc link.

Issue reference

Please reference the issue this PR will close: #602

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Created/updated tests
  • Extended the documentation

@KentHsu
doc: document that users can self-assign issues
b2c78e4 
Signed-off-by: KentHsu <chiahaohsu9@gmail.com>
@KentHsu KentHsu requested review from a team as code owners May 14, 2024 08:27
@elena-kolevska
Copy link
Contributor

Thanks Kent!
I think we should move the new paragraph at the end of the doc, though, because it doesn't read very well in continuation with the sentence before it ("When contributing to the Python SDK the following rules and best-practices should be followed").

I also think we should add the same paragraph in the README.md file, where most developers would probably look first. You can add it after "Generate gRPC Protobuf client" and before "Help & Feedback".

@berndverst
Copy link
Member

@elena-kolevska instead of directly in the Readme file I think it should be in Contributing.md

As for the docs, I agree with you on the order.

berndverst
berndverst requested changes May 16, 2024
View reviewed changes
daprdocs/content/en/python-sdk-contributing/python-contributing.md Outdated
@@ -8,6 +8,10 @@ description: Guidelines for contributing to the Dapr Python SDK

When contributing to the [Python SDK](https://github.com/dapr/python-sdk) the following rules and best-practices should be followed.

## Github Dapr Bot Commands
Copy link
Member

Choose a reason for hiding this comment

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

Move to the end of the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@KentHsu
doc: reorder paragraph and update CONTRIBUTING.md
275ee08 
Signed-off-by: KentHsu <chiahaohsu9@gmail.com>
@KentHsu
Copy link
Contributor Author

KentHsu commented May 16, 2024

I movedthe new paragraph to the end of python-contributing.md and decide to add the same paragraph in CONTRIBUTING.md. Please let me know if there are other documentations you want to update.

elena-kolevska
elena-kolevska approved these changes May 16, 2024
View reviewed changes
Copy link
Contributor

@elena-kolevska elena-kolevska left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks @KentHsu!

@codecov Codecov
Copy link

codecov bot commented May 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.35%. Comparing base (fc0e9d1) to head (6d798bc).
Report is 23 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #712      +/-   ##
==========================================
- Coverage   86.37%   86.35%   -0.02%     
==========================================
  Files          79       82       +3     
  Lines        4094     4193      +99     
==========================================
+ Hits         3536     3621      +85     
- Misses        558      572      +14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@berndverst berndverst berndverst requested changes

@elena-kolevska elena-kolevska elena-kolevska approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document That Users Can Self-Assign Issues
3 participants
@KentHsu @elena-kolevska @berndverst