-
Notifications
You must be signed in to change notification settings - Fork 32
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
chore: init repository tooling #1
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great start @remidej,
lol too eager
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great start @remidej, left some inline thoughts for discussion 👍🏼
pre pack-up
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add some github stuff – PR template, ISSUE templates, & workflows – the design-system could be a good source of inspo for these things as it's a lot lighter than the CMS repo. I would also add a CONTRIBUTING guide too, this could be adapted from the CMS one too...
A basic README.md that you add too overtime is probably very good practice as it's the source of documentation for the project :)
@joshuaellis I added some github templates, a super basic readme and a code of conduct. I think I prefer to wait a bit before writing the contributing guide and a more detailed readme, as it will be clearer what we need to put there once we have locked down the API and started the implementation. |
Definitely, I didn't expect you to have it written to a tee, instead I'd probably expect you to update it as you build the API so it's constantly up to date, good habit to get into 🤓 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's probably something forgotten, but you can always add it later – great work @remidej, setting up a brand new project has a lot of things to consider 🤪
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was interested to check how you created renderer, have few questions if you can answer, thanks!
"@testing-library/react": "^14.0.0", | ||
"lint-staged": "^15.0.1" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these dependencies should be dev right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
definitely 🙃
"react": "^18.0.0", | ||
"react-dom": "^18.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we need these in devdeps as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
otherwise we get eslint warnings about them not being installed
# local env files | ||
.env | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can clean this file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They're valid environment files picked up by vite, so people could be using them: https://vitejs.dev/guide/env-and-mode.html#env-files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right, but we do not have anything defined at the moment to gitignore. No worries as it's not doing any harm, let it be.
Sets up a TS React component library with Vite. Also sets up eslint, prettier, jest and husky.
The tools and configs were inspired by both the design system and the monorepo.