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

βž• (repo): Add gitmoji [DSDK-188] #24

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

valpinkman
Copy link
Member

@valpinkman valpinkman commented Feb 13, 2024

DSDK-188 setup git conventions

πŸ“ Description

Add Gitmoji as our new git conventions
Add a commit script to run from the root folder => pnpm commit

❓ Context

βœ… Checklist

Pull Requests must pass the CI and be code reviewed. Set as Draft if the PR is not ready.

  • Covered by automatic tests.
  • Impact of the changes:
    • Adds a new dependency + a script to use it

🧐 Checklist for the PR Reviewers

  • The code aligns with the requirements described in the linked JIRA or GitHub issue.
  • The PR description clearly documents the changes made and explains any technical trade-offs or design decisions.
  • There are no undocumented trade-offs, technical debt, or maintainability issues.
  • The PR has been tested thoroughly, and any potential edge cases have been considered and handled.
  • Any new dependencies have been justified and documented.

Copy link

vercel bot commented Feb 13, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
device-sdk-ts-sample ❌ Failed (Inspect) Feb 13, 2024 2:51pm

@valpinkman valpinkman force-pushed the feature/dsdk-188-gitmoji branch from 6cd7145 to 77638fc Compare February 13, 2024 14:43
@valpinkman valpinkman changed the title βž• (REPO): Add gitmoji βž• (DSDK-188): Add Gitmoji Feb 13, 2024
@aussedatlo
Copy link
Contributor

So the new convention for PR title is <emoji> (<ticket>): <description> ?

@valpinkman
Copy link
Member Author

valpinkman commented Feb 13, 2024

So the new convention for PR title is <emoji> (<ticket>): <description> ?

Right now i'm testing the CLI to see what it has to offer, but it seems that if we want to keep the ticket in the title we could use it in the scope, or we keep scope as it is and we just append the ticket number at the end of the commit ?

@aussedatlo @ofreyssinet-ledger @jdabbech-ledger @jiyuzhuang


Possible format

  • βž• (repo): Add gitmoji DSDK-188
  • βž• (DSDK-188): Add gitmoji
  • βž• Add gitmoji

add gitmoji dependency and `commit` script from root package.json
@valpinkman valpinkman force-pushed the feature/dsdk-188-gitmoji branch from 77638fc to 391c0ff Compare February 13, 2024 14:50
@valpinkman valpinkman changed the title βž• (DSDK-188): Add Gitmoji βž• (repo): Add gitmoji [DSDK-188] Feb 13, 2024
Copy link
Contributor

@aussedatlo aussedatlo left a comment

Choose a reason for hiding this comment

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

LGTM πŸ‘

@jiyuzhuang
Copy link
Contributor

jiyuzhuang commented Feb 14, 2024

So the new convention for PR title is <emoji> (<ticket>): <description> ?

Right now i'm testing the CLI to see what it has to offer, but it seems that if we want to keep the ticket in the title we could use it in the scope, or we keep scope as it is and we just append the ticket number at the end of the commit ?

@aussedatlo @ofreyssinet-ledger @jdabbech-ledger @jiyuzhuang

Possible format

  • βž• (repo): Add gitmoji DSDK-188
  • βž• (DSDK-188): Add gitmoji
  • βž• Add gitmoji

Thank you for your work @valpinkman. In my opinion, I prefer the second one, but can we do some adaptions like:
[DSKD-123] πŸ€ Make the project great(one space between scope and emoji, one space between emoji and commit message). Reasons below:

  1. Brackets seem more strict than parentheses(maybe a personal sentiment);
  2. Colon is not necessary because the ] or ) if you did not agree with the first point has already separate the ticket ID and the emoji.

@aussedatlo
Copy link
Contributor

aussedatlo commented Feb 14, 2024

Using gitmoji scope option, the output will automatically be formatted as <emoji> (<scope>): <message>. If we want to use custom format, I'm afraid we will need to do it ourselves without scope gitmoji option. 😒

@valpinkman
Copy link
Member Author

Using gitmoji scope option, the output will automatically be formatted as <emoji> (<scope>): <message>. If we want to use custom format, I'm afraid we will need to do it ourselves without scope gitmoji option. 😒

exactly this ^

@valpinkman valpinkman merged commit 09a8ccd into develop Feb 14, 2024
4 of 5 checks passed
@valpinkman valpinkman deleted the feature/dsdk-188-gitmoji branch February 14, 2024 10:07
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.

4 participants