Skip to content

Conversation

@martonvago
Copy link
Contributor

@martonvago martonvago commented Jun 4, 2024

Description

This PR attempts to make references to Seedcase more uniform. I've tried to stick to the following guidelines:

  • "the Seedcase Project": always capital S and P; use to refer to the project as a whole (including underpinning ideas)
  • Bare use of "Seedcase": only allow when it refers to the project as a whole in very general terms
  • "Seedcase products" / "Seedcase software" / "Seedcase software products": use to refer to the software deliverables of the project; choose best fit based on context
  • "the Seedcase framework": use to refer to the collection of software deliverables that work together to implement the core functionalities; use in older documentation to shift the meaning away from a single product without rewriting large chunks of text that will probably change significantly anyway
  • "Data Resource": always capital D and R; use to refer to the data layer in the framework and its contents

I've also formatted the files I touched, so there are some whitespace and markdown changes. These are a bit more numerous than I was expecting, and they actually make these reviews super annoying to do -- sorry about that!

In general, these changes are pretty subjective and can be controversial, so feel free to be critical.

Related Issues: seedcase-project/design#21

Testing

  • Yes
  • No, not needed (give a reason below)
  • No, I need help writing them

Tested in the browser.

Reviewer Focus

This PR only needs a quick review.

Checklist

For general documentation:

  • Spell-check
    • US
    • UK
  • Did the page(s) preview correctly on your machine without breaking
  • New category words (keywords) (if any) added to the code snippet file

@martonvago martonvago self-assigned this Jun 4, 2024
---
title: "Why conventional commits (with optional emojis)"
description: "Our reasons for using conventional commits (with optional emojis following the Gitmoji convention) across Seedcase projects."
description: "Our reasons for using conventional commits (with optional emojis following the Gitmoji convention) across Seedcase codebases."
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here and below just trying to avoid using "projects" when we have "the Seedcase Project" as an overarching category.

@martonvago martonvago marked this pull request as ready for review June 4, 2024 12:45
@martonvago martonvago requested a review from a team as a code owner June 4, 2024 12:45
Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

A small change.

Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
@lwjohnst86 lwjohnst86 merged commit 42affc5 into main Jun 7, 2024
@lwjohnst86 lwjohnst86 deleted the docs/seedcase-terminology branch June 7, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants