8000 chore: Update README.md (#328) · CaffeeLake/adk-python@22cab9e · GitHub
[go: up one dir, main page]

Skip to content

Commit 22cab9e

Browse files
authored
chore: Update README.md (google#328)
* chore: Update README.md chore: update readme for contributing guideline * chore: Update CONTRIBUTING.md chore: Update CONTRIBUTING.md * Update CONTRIBUTING.md
1 parent a9da7a8 commit 22cab9e

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,22 @@ This project follows
2525

2626
## Contribution process
2727

28+
### Requirement for PRs
29+
30+
- All PRs, other than small documentation or typo fixes, should have a Issue assoicated. If not, please create one.
31+
- Small, focused PRs. Keep changes minimal—one concern per PR.
32+
- For bug fixes or features, please provide logs or screenshot after the fix is applied to help reviewers better understand the fix.
33+
- Please add corresponding testing for your code change if it's not covered by existing tests.
34+
35+
### Large or Complex Changes
36+
For substantial features or architectural revisions:
37+
38+
- Open an Issue First: Outline your proposal, including design considerations and impact.
39+
- Gather Feedback: Discuss with maintainers and the community to ensure alignment and avoid duplicate work
40+
2841
### Code reviews
2942

3043
All submissions, including submissions by project members, require review. We
3144
use GitHub pull requests for this purpose. Consult
3245
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
33-
information on using pull requests.
46+
information on using pull requests.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ for how they can work together.
121121

122122
## 🤝 Contributing
123123

124-
We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our [**Contributing Guidelines**](./CONTRIBUTING.md) to get started.
124+
We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our
125+
- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/#questions).
126+
- Then if you want to contribute code, please read [Code Contributing Guidelines](./CONTRIBUTING.md) to get started.
125127

126128
## 📄 License
127129

0 commit comments

Comments
 (0)
0