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

Suggestions: package maintenance improvements #141

Open
6 of 7 tasks
marcalexiei opened this issue Jun 29, 2024 · 0 comments
Open
6 of 7 tasks

Suggestions: package maintenance improvements #141

marcalexiei opened this issue Jun 29, 2024 · 0 comments

Comments

@marcalexiei
Copy link
Collaborator

marcalexiei commented Jun 29, 2024

Follow up to #140

Note

I'm creating a separate issue since the following changes should not affect package behaviour in user land.

Note

Alike #140 If you are ok with at least one of the proposed changes I can take care of doing separate PR's 😁

Linter

eslint is installed in devDependencies but it is not used in npm scripts or in actions as far as I can tell.
It would be good to use the default configuration combined with https://typescript-eslint.io plugin

Formatter

Alongside with linting it would be good to have also a formatter.
prettier is widely adopted so I would go for it, alternatively there is biomejs.

Unit test using snapshots

#139 (comment)

Add more check to GitHub actions

  • Add checks for all supported node version
  • Add lint and format checks too

Add commit message linter

In order to ease changelog maintenance (#118), commits should follow conventional commits.
Having a commit linter + a git hooks manager will enable commit message validation on user commit:

Examples:


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants