Skip to content

Commit

Permalink
Added Ideas to showcase page (#336)
Browse files Browse the repository at this point in the history
* Added Ideas to showcase page

* Refactor: Standardize terminology from "Open-Source" to "Open-source" 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.
  • Loading branch information
sainty0 authored Sep 21, 2024
1 parent 8e74c1e commit ebcf07c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions content/showcase/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ <h1 class="title is-2">UQCS Showcase</h1>
link="https://github.com/nafisazizir/uquizzle"
class="showcase-element has-text-centered"
>}}
{{< showcase-item
src="/img/media/showcase/ideas.png"
title="Ideas"
caption="<p>Open-source screenplay writing tool that let's you rearrange scenes and create storyboard images using AI.</p><p><b>2024 Hackathon Best Interdisciplinary</b></p>"
image-class="showcase-image"
link="https://github.com/sainty0/ideas"
class="showcase-element has-text-centered"
>}}
{{< showcase-item
src="/img/media/showcase/codeduel.png"
title="CodeDuel"
Expand Down
Binary file added static/img/media/showcase/ideas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ebcf07c

Please sign in to comment.