search

csdojo-defaang / defaang

A website that will curate recently-asked interview questions from FAANG+. Currently inactive. Check out: https://github.com/ykdojo/OpenStream
MIT License
509 stars 120 forks source link

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

Closed ykdojo closed 2 years ago

ykdojo commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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

AakashRaj20 commented 2 years ago

@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 commented 2 years ago

@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 commented 2 years ago

Did you test it?

AakashRaj20 commented 2 years ago

Did you test it?

Yes it's working fine

ykdojo commented 2 years ago

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

veganaize commented 2 years ago

Note: Addresses #113

AakashRaj20 commented 2 years ago

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 commented 2 years ago

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

AakashRaj20 commented 2 years ago

@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 commented 2 years ago

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.