exadel-inc / esl

Lightweight and flexible UI component library based on web components technology for creating basic UX modules
https://esl-ui.com
MIT License
57 stars 9 forks source link

[🔨 code style]: replace tense of verbs in TS Docs descriptions #521

Open abarmina opened 2 years ago

abarmina commented 2 years ago

As a member of the ESL dev team, I want to be able to see the use of third-person singular verbs in Present Simple in component TS Doc descriptions.

For example (current state -> proposed state):

Scope of the issue:

We suggest opening separate pull requests for each component or directory.

Onyinye91-ctrl commented 2 years ago

@abarmina Can you assign this to me?

ala-n commented 2 years ago

Hey @Onyinye91-ctrl, sure, assigned this issue to you. We really appreciate your help with the ESL project!

Onyinye91-ctrl commented 2 years ago

Thanks @ala-n but i can't find were to make those changes

abarmina commented 2 years ago

Thanks @ala-n but i can't find were to make those changes

Hi @Onyinye91-ctrl! All of these files are located in the src/modules folder. For example, you can find esl-alert in this path - src/modules/esl-alert/core/esl-alert.ts. If necessary, I can add a path to all files.

Onyinye91-ctrl commented 2 years ago

@abarmina well Noted. Thanks

Onyinye91-ctrl commented 2 years ago

@abarmina I should change the following to plural right? ch

abarmina commented 2 years ago

@Onyinye91-ctrl, no, only descriptions (comments) need to be changed. For example:

Screenshot 2021-10-08 at 15 34 25

or

Screenshot 2021-10-08 at 15 35 34
Onyinye91-ctrl commented 2 years ago

Okay @abarmina So I should be looking out for these verbs, create and return only or is there more?

abarmina commented 2 years ago

@Onyinye91-ctrl, these can be different verbs, "create" and "return" were just examples. I slightly changed the description, added paths to files. If anything, feel free to ask =) As an option, you can change one file and open a pull request, and we can comment on it if something suddenly goes wrong

Onyinye91-ctrl commented 2 years ago

@abarmina Thanks i will do as you suggested

aswinidev commented 2 years ago

I would like to work on this issue. Would you please assign this to me?

abarmina commented 2 years ago

I would like to work on this issue. Would you please assign this to me?

Sandra is currently working on this issue, but we have several files, so we will be glad to add you ,@aswinidev, as a second contributor. Sandra is working on src/modules/esl-alert/core/esl-alert.ts file, and you can choose any other from the list

Onyinye91-ctrl commented 2 years ago

@ala-n Can i take another file?

ala-n commented 2 years ago

Hey @Onyinye91-ctrl sure, take another file. But please be aware that the maintainer's team (@exadel-inc/esl-core-team) can not spend much time on support with documentation tickets. Please follow our Contribution Guide and be careful in your changes.