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

Rewrite project into TypeScript #570

Open
christian-bromann opened this issue Oct 19, 2021 · 9 comments
Open

Rewrite project into TypeScript #570

christian-bromann opened this issue Oct 19, 2021 · 9 comments
Assignees
Labels
Hacktoberfest Issues that were selected to work on during Hacktoberfest help wanted

Comments

@christian-bromann
Copy link
Member

We made the experience that switching to TypeScript had a good impact on the code quality and development velocity. We should also rewrite this project into TypeScript to leverage from the same.

@christian-bromann christian-bromann added Hacktoberfest Issues that were selected to work on during Hacktoberfest help wanted labels Oct 19, 2021
@VedanthB
Copy link

I would like to work on this.

@christian-bromann
Copy link
Member Author

Awesome, thanks for stepping in. I would suggest to tackle this in small pieces, e.g. rather raising many small PRs than one huge one.

@VedanthB
Copy link

Okay should i start with installing typescript in the project and then write the files in typescript one by one ?

@christian-bromann
Copy link
Member Author

@VedanthB sounds like a good approach, maybe have a first PR that provides the TS setup and already have the package point to the compiled JS files. Then a PR for every file.

@VedanthB
Copy link

I'll submit the PR in a day 😄

@VedanthB
Copy link

Can i get help to get this running on my local machine ?

@christian-bromann
Copy link
Member Author

Can i get help to get this running on my local machine ?

Sure, where do you struggle with? Did you check out the Contributing guidelines. It isn't much but it helped me to get it setup locally.

@VedanthB
Copy link

i have cloned the project and npm install , what would be the next steps?

@christian-bromann
Copy link
Member Author

what would be the next steps?

You should be able to run all tests via npm test now. The next step is setup TypeScript.

@seanpoulter seanpoulter self-assigned this Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest Issues that were selected to work on during Hacktoberfest help wanted
Projects
None yet
Development

No branches or pull requests

3 participants