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

chore: standardise exports to camel case #1933

Open
danisharora099 opened this issue Mar 28, 2024 · 10 comments
Open

chore: standardise exports to camel case #1933

danisharora099 opened this issue Mar 28, 2024 · 10 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@danisharora099
Copy link
Collaborator

This is a change request

Problem

We currently have camel case as well as snake case exports within our codebase:

image

Proposed Solutions

Standardise it to use camel case

Notes

@varunsh20
Copy link

Can I start working on it?

@weboko
Copy link
Collaborator

weboko commented Mar 28, 2024

of course @varunsh20 ! ping me if you need any help with it

@danisharora099
Copy link
Collaborator Author

danisharora099 commented Mar 28, 2024

sounds good -- let's confirm the scope of this issue before we move forward.

@waku-org/js-waku-developers are we deciding to stick with camel case?
also related: our file names are done in snake-case. how do we feel about that change? @weboko

@varunsh20
Copy link

image

there are already functions defined in these modules with the same name in camel casing, shall I rename those functions or rename the module name along with camel casing?

@weboko
Copy link
Collaborator

weboko commented Mar 28, 2024

are we deciding to stick with camel case?

we already are using camel case almost everywhere for our code (as you noted - not files or packages tought)

our file names are done in snake-case

I think we can keep files for later to be changed, maybe as follow up @danisharora099


@varunsh20 good observation. To me it seems fine to rename waku_filter or other similar exports of a module to wakuFilterModule

cc @waku-org/js-waku-developers

@varunsh20
Copy link

Please review it and let me know if any changes are required.

@weboko weboko moved this to Triage in Waku Apr 24, 2024
@weboko weboko moved this from Triage to Code Review / QA in Waku Apr 24, 2024
@weboko
Copy link
Collaborator

weboko commented Apr 24, 2024

@varunsh20 apologies for such long reply as our team had some activities this month. Ping if your are willing to complete this task or interested in contributing more!

@danisharora099
Copy link
Collaborator Author

@varunsh20 I had left a review on your PR #1934 (comment)

@danisharora099
Copy link
Collaborator Author

Hey @varunsh20 are you still interested in addressing comments on the PR? Mostly seems good, just need to ensure CI passes.

@danisharora099 danisharora099 moved this from Code Review / QA to Blocked in Waku May 15, 2024
@danisharora099 danisharora099 moved this from Blocked to To Do in Waku May 30, 2024
@danisharora099
Copy link
Collaborator Author

Up for grabs again

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: To Do
Development

Successfully merging a pull request may close this issue.

3 participants