add more information and guideline for Contributing page.#762
add more information and guideline for Contributing page.#762kubeedge-bot merged 1 commit intokubeedge:masterfrom
Conversation
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Summary of ChangesHello @fujitatomoya, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the KubeEdge project's Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
kubeedge-bot
added
the
size/M
| | | Golang 1.11 | Golang 1.12 | Golang 1.13 | Golang 1.14 | | ||
| |-------------------------|-----------------|-----------------|-----------------|-----------------| | ||
| | KubeEdge 1.2 | ✗ | ✓ | ✓ | ✓ | | ||
| | KubeEdge 1.3 | ✗ | ✓ | ✓ | ✓ | | ||
| | KubeEdge 1.4 | ✗ | ✗ | ✗ | ✓ | | ||
| | KubeEdge HEAD (master) | ✗ | ✗ | ✗ | ✓ | |
There was a problem hiding this comment.
i guess this is toooooo old and out dated, so that we can remove this entire section from here. (for along time, nobody has complained about this. that said, it is safe to remove.)
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the contributor guide by adding detailed instructions for contributing to both the KubeEdge codebase and its documentation. The new structure is clear and provides valuable information for new contributors. I've left a couple of comments to improve the accuracy of the provided commands and contribution process details. Overall, this is a great enhancement to the project's documentation.
| 4. **Test your changes** locally before submitting: | ||
| ```bash | ||
| make verify # Run verification checks | ||
| make lint # Run linting |
There was a problem hiding this comment.
The make lint command is not mentioned in the Developer Guide, which is referenced as the source for building and testing. This might cause confusion or errors for new contributors if the lint make target doesn't exist. Please consider removing this command to align with the developer guide, or update the guide to include it if it's a valid and recommended step.
|
|
||
| 5. **Push to your fork** and create a pull request to `kubeedge/kubeedge` | ||
|
|
||
| 6. **Address review feedback** - PRs require approval from two maintainers |
There was a problem hiding this comment.
The Community Membership guide indicates that Approvers review and approve contributions, while Maintainers typically have merge rights. Specifying maintainers here could be inaccurate. To align with the defined community roles, it would be better to state that approvals are needed from approvers.
| 6. **Address review feedback** - PRs require approval from two maintainers | |
| 6. **Address review feedback** - PRs require approval from two approvers |
Shelley-BaoYue
left a comment
Shelley-BaoYue
left a comment
There was a problem hiding this comment.
Good content for new contributors! 👍
/lgtm
/approve
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Shelley-BaoYue The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubeedge-bot
added
the
approved
3 participants
Which issue(s) this PR fixes:
Fixes #761
add more description and guideline to navigate the users and developers how to make contribution to kubeedge implementation and documentation.
Not much information there
Clear guideline to take the users and developers to the appropriate page.
No