-
Notifications
You must be signed in to change notification settings - Fork 723
feat: add dedicated newcomers guide page #2440
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
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: thund3rhawk <[email protected]>
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, please review the Newcomers' Guide and sure to join the community Slack. |
✅ Deploy Preview for mesheryio-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @Thund3rHawk, 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 introduces a comprehensive 'Newcomers' guide page aimed at streamlining the onboarding process for new contributors. It integrates various resources, including a step-by-step contribution guide, a curated list of tutorials, and direct links to community engagement platforms. The goal is to provide a welcoming and informative entry point for individuals looking to get involved with the project, enhancing the overall contributor experience. Highlights
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a new dedicated page for newcomers, which is a great initiative. It includes a contributor's journey map, a guide on how to contribute, a list of tutorials, and a call to action to join the community. The changes are well-structured, but there are several areas for improvement regarding code quality and maintainability.
Key feedback points:
- CSS Organization: Several new HTML files contain large blocks of inline CSS. It would be better to extract these styles into separate SCSS files under the
_sassdirectory for better organization, maintainability, and reusability, following the pattern already used for_sass/tutorials-table.scss. - Code Quality: There are some issues like placeholder links (
href="#"), invalid HTML attributes (target=""), and incorrect SCSS selectors that need to be addressed. - Best Practices: The use of
!importantin CSS should be avoided as it can lead to maintenance issues. Also, several new files are missing a final newline character, which is a common convention. - Sass Syntax: There's a syntax error in
css/screen.scssthat will break the SCSS compilation.
Signed-off-by: thund3rhawk <[email protected]>
|
@Thund3rHawk please look over the suggestions first and resolve them if in high priority. |
Signed-off-by: thund3rhawk <[email protected]>
|
Resolved high and medium priority bugs as per code review recommendations. |
Description
This PR fixes #2178
Notes for Reviewers
Signed commits