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.

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

Added Ideas to showcase page #336

Merged
merged 2 commits into from
Sep 21, 2024
Merged

Conversation

sainty0
Copy link
Contributor

@sainty0 sainty0 commented Sep 21, 2024

No description provided.

Copy link
Member

@49Indium 49Indium left a comment

Choose a reason for hiding this comment

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

Looks good. Just one small spelling change needed.

content/showcase/_index.html Outdated Show resolved Hide resolved
… throughout the project

This commit addresses a small but meaningful inconsistency in the project’s terminology by changing all instances of "Open-Source" (with a capital "S") to the more standardized and grammatically correct form, "Open-source" (with a lowercase "s").

The term "open source" is widely recognized in the software community as referring to software with source code that is made freely available for modification and redistribution. When hyphenated and capitalized as "Open-Source," the term introduces unnecessary variation in capitalization and word structure. To ensure consistency and align with common industry practices, the word should be formatted as "Open-source" when used as a compound adjective (e.g., "Open-source software").

- Conducted a thorough search across the repository to ensure no instances were missed.
- This change also improves readability and professionalism, especially in external-facing materials where potential contributors and users may come across the term.

- The change does not affect any functional parts of the codebase, meaning no breaking changes or regression risks are introduced.
- This is purely a cosmetic and consistency-improving refactor, but it enhances the clarity and professionalism of our project's language.
- Aligning with standard terminology may also help search engines and external references better categorize the project as adhering to standard open-source conventions.

- Special care was taken not to alter any third-party libraries, licenses, or external documentation that may use "Open-Source" in a specific, intentional manner.
- Automated and manual tests have been run to ensure there are no unintended consequences from these text changes.

- Moving forward, all new documentation and code comments should adopt the "Open-source" convention to maintain this consistency.
- It may be worth considering adding this to the style guide for contributors to avoid any future discrepancies in terminology.

This commit, while seemingly minor, contributes to the overall polish of the project and aligns with industry best practices, ensuring that our project remains clear, professional, and approachable.
Copy link
Member

@49Indium 49Indium 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! Will add to the website now.

@49Indium 49Indium merged commit ebcf07c into UQComputingSociety:main Sep 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants