Booster-54: Contribute Page #380
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ing requirements for code quality, documentation, browser compatibility, innersource process, and communication. Update initialization steps with system requirements and installation instructions, including a comprehensive overview of the build process using Lerna and Yarn.
steveT-80
added
documentation
✅ Deploy Preview for booster-zywave ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Alex Recommends ReportAlex recommends the following language changes, but Alex is a regular expression based algorithm, so take them with a grain of salt. src/_areas/introduction/contributing/contribute-to-design-system/index.md
|
I think it makes sense to document with yarn, and we'll just update when we do the conversion. |
p-ob
requested changes
Mar 19, 2025
| 1. Document any new functionality you add or functionality you change to be published on this site. | ||
| 1. Test your changes in the [recommended browsers at Zywave](https://support.zywave.com/s/article/Zywave-browser-recommendations) to ensure they work properly. | ||
| 1. Ping the App Platform team in Microsoft Teams when you have a merge request ready for review. | ||
| Here are the requirements when contributing to our design system through innersource: |
There was a problem hiding this comment.
Suggested change
| Here are the requirements when contributing to our design system through innersource: | |
| Here are the requirements when contributing to our design system through InnerSource: |
| - Keep your changes focused and atomic | ||
|
|
||
| 2. **Documentation** | ||
| - Document all new functionality and changes in this documentation site |
There was a problem hiding this comment.
Suggested change
| - Document all new functionality and changes in this documentation site | |
| - Document all new functionality and changes. | |
| - Component API documentation is managed via [JSDoc](https://jsdoc.app/) comments in source code. Additional JSDoc tags are provided by [@custom-elements-manifest/analyzer](https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#supported-jsdoc) | |
| - Other documentation changes can be added to this site via <https://github.com/Zywave/booster> |
| - Ensure responsive behavior works as expected | ||
| - Verify accessibility compliance | ||
|
|
||
| 4. **Innersource Process** |
There was a problem hiding this comment.
Suggested change
| 4. **Innersource Process** | |
| 4. **InnerSource Process** |
| - Be responsive to questions and feedback | ||
| - Keep the team informed of significant changes | ||
|
|
||
| <docs-note>Remember that innersource contributions should follow the same high standards as internal development. If you're unsure about any requirements, don't hesitate to ask in the Booster Teams channel or on the Jira Booster ticket.</docs-note> |
There was a problem hiding this comment.
Suggested change
| <docs-note>Remember that innersource contributions should follow the same high standards as internal development. If you're unsure about any requirements, don't hesitate to ask in the Booster Teams channel or on the Jira Booster ticket.</docs-note> | |
| <docs-note>Remember that InnerSource contributions should follow the same high standards as internal development. If you're unsure about any requirements, don't hesitate to ask in the Booster Teams channel or on the Jira Booster ticket.</docs-note> |
| * Runs through every package defined in the monorepo and executes their `"build"` script as defined in their respective *package.json* file. | ||
| ### System Requirements | ||
| - Node.js 20.17.0 or higher (recommended to use nvm for version management) | ||
| - Yarn 1.22.22 or higher |
There was a problem hiding this comment.
Not sure how to best clarify this to indicate that they have to use yarn v1, and not v2 or v3.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Did my best to update the contribute requirement to use the Innersource guidelines. I also updated the initialization steps to to be a bit more specific regarding dependencies and break the steps up and explanations because even though I had a version of node that should have been es2018 compliant I was getting build errors because of incapability issues with this import using
with.import pkg from './package.json' with { type: 'json' };The LTS version of node (20.17.00) worked so i set it to that.
also I know we are moving to
NPMsoon but i leftYarnin there still.