-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Improved upto 1-js\02-first-steps\13-while-for #3703
Conversation
Improved readability of old content and add one new para which tells where to place <script> tag in HTML
Improved the readability of the content but stating things clearly in simple words.
Added details about use of comma operator with examples , also improved readability of the page by explain some content more clearly , also modified reference to code lines by referencing them directly because we see line no. of code automatically , there is not need to mark them separately.
…lution.md updated here I removed special marking to code lines because we automatically get line no. on the website. also i provided explaination for all the example in the code.
I updated this file so that some content is explained clearly.
did a very minor update in file
…and task.md updated In these files I have added more examples and explained previous ones in detail.
I have updated this file with minor changes to explain things better and clearly
modified a JS code to improve readability
…dified modified this file's code to use const instead of let ,because we won't be modifying the variables later
I have made major changes to this file , added examples which were needed but not given , added some more sections such as 'Understanding loops' to generally explain loops , "Multiple Labels and Breaking Nested Loops" to explain how deeply nested loops can be labelled. also made some minor changes to match with general term of Js.
Improved a code example, corrected a markdown error ,improved readability for one line , added a note to explain where a default can be placed in the switch and using break with it , added one another note to recommend using curly brace to put together all the statements of a switch case.
I have updated this file to make this more clear and easily understandable , also added details about call by value/call by reference in JS. At one place i remove a duplication (not exactly same ,but could be combined) regarding use of default. Also added rules to pick a name for function.
I have updated this file with some more changes, made some grammatical corrections, and also added more detailed content
When I read this chapter I felt like I am always searching for the content , it was not well arranged , and when new topics started their clear explanation was not provided. So I have rearranged the content in topics and sub topics , also provided clear explanations of topics such as callbacks , also added explanation for new terms such as Hoisting
@smith558 please let me know if my changes are acceptable and makes the project better overall as I would like to work further on the project ,making it simple to understand and easy to grasp. |
the variables created inside let A =(var1 , var2 , ... , varN ) => { //code } should be termed as parameters not arguments
@smith558 hey any update ? did you check the changes ? |
This one is next in the queue. |
Wow |
Hello, |
Sorry for the delay. I started listing issues, but they are not so helpful without long explanations Read this as if you were an alien lang maintainer. You'll understand.
Extra toughs I learned this contributing to this repo, so I hope this opens your mind too. About specific changes, Being spanish js maintainer, Hope this helps. |
I'm partially wrong about translated repos Using the bot merge, all the pr are combined in a single bot's PR, thats why I used to frecuently make my own merges. Being labeled "readability", i can dismiss all the changes without feeling guilty... Still, |
I cannot review grammar, I'm not native English speaker. Couple of things in a quick review. I prefer the Parameter is part of the definition of the function, Backticks format reserved words, you used them indiscriminately in many places I remember a let to const replacement pr rejected by Illya, i cant remember if he gave a reason Again, |
Hi @joaquinelio, Thank you for your detailed feedback and for clarifying your perspective. I appreciate your insights on managing PRs effectively. Now that I look at my PR, I realize that I didn’t explain my changes in a precise manner and instead provided more general explanations. I also understand that since this repo is translated into other languages, changes in one repository need to be reflected across others, making it challenging to manage large PRs with significant alterations. I understand now that large PRs can be hard to review, and breaking changes into smaller, more focused submissions would be more beneficial for reviewers. I’ll make sure to keep my future contributions more streamlined and specific, ideally tackling one issue or topic at a time. Regarding the specific points you mentioned:
If I may suggest, while I’m still learning, I believe having a clear contributions guideline could be very helpful for contributors. It might assist in understanding the format and best practices to follow. Moving forward, should I close this PR and create smaller, more focused ones with the bare minimum changes I believe should be made? Or would it be better to modify this PR to address the points you raised? If you have additional thoughts or specific examples of what could be improved, I’d love to hear them. Thank you again for your guidance! I’m eager to refine my contributions and make the project better overall. |
changed files and about changes
1. js/first steps/hello world/artical.md
Improved readability of old content and add one new para which tells where to place <script> tag in
2. 1-js\02-first-steps\07-type-conversions\article.md
Improved the readability of the content but stating things clearly in simple words.
3. 1-js\02-first-steps\08-operators\article.md
Added details about use of comma operator with examples , also improved readability of the page by explain some content more clearly , also modified reference to code lines by referencing them directly because we see line no. of code automatically , there is not need to mark them separately.
4. 1-js\02-first-steps\08-operators\3-primitive-conversions-questions\solution.md
here I removed special marking to code lines because we automatically get line no. on the website. also i provided explaination for all the example in the code.
5. 1-js\02-first-steps\09-comparison\article.md
I updated this file so that some content is explained clearly.
6. 1-js\02-first-steps\09-comparison\1-comparison-questions\solution.md and task.md
In these files I have added more examples and explained previous ones in detail.
7. 1-js\02-first-steps\10-ifelse\article.md
I have updated this file with minor changes to explain things better and clearly
8. 1-js\02-first-steps\11-logical-operators\article.md
modified a JS code to improve readability
9. 1-js\02-first-steps\11-logical-operators\9-check-login\solution.md
modified this file's code to use const instead of let and explained it ,because we won't be modifying the variables later
10. 1-js\02-first-steps\13-while-for\article.md
I have made major changes to this file , added examples which were needed but not given , added some more sections such as 'Understanding loops' to generally explain loops , "Multiple Labels and Breaking Nested Loops" to explain how deeply nested loops can be labelled. also made some minor changes to match with general term of Js.
11. 1-js\02-first-steps\14-switch\article.md
Improved a code example, corrected a markdown error ,improved readability for one line , added a note to explain where a default can be placed in the switch and using break with it , added one another note to recommend using curly brace to put together all the statements of a switch case.
12. 1-js\02-first-steps\15-function-basics\article.md
I have updated this file to make this more clear and easily understandable , also added details about call by value/call by reference in JS. At one place i remove a duplication (not exactly same ,but could be combined) regarding use of default. Also added rules to pick a name for function.
13. 1-js\02-first-steps\16-function-expressions\article.md
When I read this chapter I felt like I am always searching for the content , it was not well arranged , and when new topics started their clear explanation was not provided. So I have rearranged the content in topics and sub topics , also provided clear explanations of topics such as callbacks , also added explanation for new terms such as Hoisting
14. 1-js\02-first-steps\17-arrow-functions-basics\article.md
the variables created inside let A =(var1 , var2 , ... , varN ) => { //code } should be termed as parameters not arguments