search

th3cyb3rhub / thecyberhub-app

Thecyberhub app of @th3cyb3rhub community
MIT License
12 stars 10 forks source link

[FEATURE] Code Linting #9

Closed ATH42 closed 2 years ago

ATH42 commented 2 years ago

Detailed description

The Codebase is pretty Raw at this point. To make onboarding and contributing easier, lint rules and maybe a prettier setup are recommended

Context

easiier to contribute. no need for maintainers to force specific code styles in commentary -> can be handled by repo

Possible implementation

esLint, Prettier

maybe tsconfig?

Additional information

No response

Code of Conduct

github-actions[bot] commented 2 years ago

It's great having you contribute to this project

🌟 Welcome to the community 🌟

- If you would like to continue contributing to open source and would like to do it with an awesome inclusive community. - You should join our [Discord](https://discord.gg/QHBPq6xP5p) chat and our [GitHub Organisation](https://github.com/thecyberworld). - We help and encourage each other to contribute to open source little and often 😄. - Any questions let us know.

ATH42 commented 2 years ago

hey @kabir0x23 do you think this a good idea?

if yes i could set up some rules.

kabir0x23 commented 2 years ago

hey @kabir0x23 do you think this is a good idea?

if yes I could set up some rules.

Yes, this is a great idea.

I have also tried linting once on one of my project, linter and prettier on commit.

Yes, go ahead 🚀.

ATH42 commented 2 years ago

this is ready, but please merge #10 before this.

it would be recommended to maybe create another branch, to base feature branches off.

maybe:

main for production ready develop for developing and to base feature branches off?

kabir0x23 commented 2 years ago

Okay nice, Got it

Like create a develop branch only for developing purposes. and main for developing

can you elaborate on, to base feature branches off?

kabir0x23 commented 2 years ago

this is ready, but please merge #10 before this.

it would be recommended to maybe create another branch, to base feature branches off.

maybe:

main for production-ready development for developing and to base feature branches off?

like? first merging PRs in dev branch (linters will their work) and then we will merge it into the main branch

ATH42 commented 2 years ago

exactly, the only branch that merges into master is develop all other branches go into develop first.

for example: checkout develop -> pull -> checkout -b some-feature -> PR to develop

I will add an action to check code in CI tomorrow, but you can still merge this, i will do all the actions on another branch.

kabir0x23 commented 2 years ago

exactly, the only branch that merges into master is develop all other branches go into develop first.

Nice Nice

kabir0x23 commented 2 years ago

Okay got it.

kabir0x23 commented 2 years ago

exactly, the only branch that merges into master is develop all other branches go into develop first.

for example: checkout develop -> pull -> checkout -b some-feature -> PR to develop

I will add an action to check code in CI tomorrow, but you can still merge this, i will do all the actions on another branch.

I will a create a development branch