Skip to content
This repository has been archived by the owner on Jan 20, 2024. It is now read-only.

[DX] <Clean up the root directory> #113

Closed
ykdojo opened this issue Aug 22, 2022 · 14 comments
Closed

[DX] <Clean up the root directory> #113

ykdojo opened this issue Aug 22, 2022 · 14 comments
Assignees

Comments

@ykdojo
Copy link
Collaborator

ykdojo commented Aug 22, 2022

Description

The root directory has many dotfiles and config files, and it's not a very pleasant experience.

We should clean up some of them so it's easier to get started contributing to this repo.

@AakashRaj20
Copy link

Description

The root directory has many dotfiles and config files, and it's not a very pleasant experience.

We should clean up some of them so it's easier to get started contributing to this repo.

Hey @ykdojo I would like to try this issue can you assign this to me 😄

@benny123tw
Copy link
Contributor

We can put .lintstagedrc and .commitlintrc.json in our package.json.

See:

  1. https://github.com/okonet/lint-staged#Configuration
  2. https://github.com/conventional-changelog/commitlint#config

@AakashRaj20
Copy link

Description

The root directory has many dotfiles and config files, and it's not a very pleasant experience.

We should clean up some of them so it's easier to get started contributing to this repo.

Hey @ykdojo I wanted to ask that should I make a new folders for dotfiles and config files and move them to their respective folders?

@ykdojo
Copy link
Collaborator Author

ykdojo commented Aug 23, 2022

@AakashRaj20 yes that might work well. Just make sure that these dotfiles work even if they're put in folders.

@AakashRaj20
Copy link

@AakashRaj20 yes that might work well. Just make sure that these dotfiles work even if they're put in folders.

ok will do that

@AakashRaj20
Copy link

@AakashRaj20 yes that might work well. Just make sure that these dotfiles work even if they're put in folders.

Hey I have moved all the dot files in a separate folder and as there are only 3 config files, so I guess it will not be needed should I raise a PR so that you can have a look?

@ykdojo
Copy link
Collaborator Author

ykdojo commented Aug 24, 2022

Did you test it?

@AakashRaj20
Copy link

Did you test it?

Yes it's working fine

@ykdojo
Copy link
Collaborator Author

ykdojo commented Aug 24, 2022

Great. When you open the PR, do you mind explaining how you tested each file you moved?

@veganaize
Copy link
Contributor

Note: Addresses #113

@AakashRaj20
Copy link

Great. When you open the PR, do you mind explaining how you tested each file you moved?
So actually for testing I launched the website in my local machine and everything was working fine, so can you guide me on how can perform specific test for each file?

@ykdojo
Copy link
Collaborator Author

ykdojo commented Aug 24, 2022

@AakashRaj20 I didn't create some of the files, so could you find the person who created each one and ask them?

@AakashRaj20
Copy link

@AakashRaj20 I didn't create some of the files, so could you find the person who created each one and ask them?

Ok will do so

@iShibi
Copy link
Contributor

iShibi commented Sep 1, 2022

Closing this as config files are supposed to be in the root directory for them to work. The other ways of "hiding" them are not very worth it which include polluting package.json and editor-specific features.

@iShibi iShibi closed this as completed Sep 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

5 participants