Created table of contents, corrected spelling and punctuation

[OlaPom]

• corrected minor stylistic and spelling errors
• added section numbers
• created a table of contents

[OlaPom]

Issue #79

[amtoine]

Issue #79

you can use https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue directly in the PR description if you want to link it yourself 😉
e.g. should fix #79 😋

[amtoine]

simple and great, looks good to me 👌

[ctmbl]

Thanks a lot for your contribution! I added a few suggestion I already had in mind 😉

[ctmbl]

Good to go!

[amtoine]

@OlaPom
that looks good but the CI is not happy 😏
you will have to run the same prettier command as in the CI to fix the formatting 😌

[OlaPom]

I've been looking for instructions, but I need an explanation. Can this be done with GitHub Actions or do I need to install some tools? (Because if it's the latter, I'm afraid my technical skills may not be enough).

[amtoine]

@OlaPom

I've been looking for instructions, but I need an explanation.

this should be added in the repo 👍

Can this be done with GitHub Actions or do I need to install some tools? (Because if it's the latter, I'm afraid my technical skills may not be enough).

yeah we chose not to commit in the name of our contributors, to control what's going on in the PR branches 😌
i'm not a node nor JS chad, but here is a command that does the job

npx prettier --write .

Note
see https://prettier.io/docs/en/install.html

[ctmbl]

@OlaPom

I've been looking for instructions, but I need an explanation. Can this be done with GitHub Actions or do I need to install some tools? (Because if it's the latter, I'm afraid my technical skills may not be enough).

This can't be done with GitHub Actions, because we don't want automated tools to modify our code without our approbation.
However this shouldn't be a problem for this doesn't require any technical skills.

First you need to install npm
Then in a terminal (on Windows: Windows Key + R then type "cmd.exe") run npm install -g prettier
Finally at the source folder of this repo run prettier --write README.md
This should do!
If you still believe you can't do it, I will no problem 😉

PS: to remove it afterwards (if you want to), run npm uninstall -g prettier

[ctmbl]

@OlaPom
Also there are conflicts with the main branch, you should solve it with a git merge not a git rebase
Again if you want I can do it 😉

[amtoine]

@ctmbl jinx 😏

[ctmbl]

@OlaPom after your git merge main you'll have the recent #99 on your dev branch, so you'll be able to just do npm run pretty to prettify the code!

Note
you'll still need to install prettify first

[OlaPom]

Thank you for the instructions! Let me try 💪

[ctmbl]

No problem, looking forward to see your commit!

[atxr]

Thanks for you contribution and for correcting my (stupid) English typos 🙂
You did a good job 🥳
We just wait for prettier now, and then we will merge your work 🥇
(don't hesitate to reach us if you experience any trouble with prettier)

[OlaPom]

I installed prettier, and it works, but the rule doesn’t. When I do npm run pretty in the main folder of the repo, I get this:

iscsc.fr@0.1.2 pretty

npx prettier --write ‘/*.{js,md,yml,css,html}’ ‘!mongodb/’

[error] No files matching the pattern were found: “‘**/*.{js,md,yml,css,html}’”.

[error] No files matching the pattern were found: “‘!mongodb/**’”.

I’m on Windows. I googled this error, and it may have sth to do with the quotes.

I copied the readme file to another folder and was able to format it with prettier --write. I tried it on a copy for now, because I thought you’d prefer people to run the script. Let me know if it makes any difference. If not, I’ll format the file and push it. Or let me know if I need to do anything to make the rule work on my computer.

[atxr]

@OlaPom I ran prettier on my machine and created a pull request on your branch
You can merge it and it will resolve this PR
Sorry for the disturbances

[ctmbl]

Like @atxr I managed to run it on Linux, sorry it doesn't work on Windows, but tks for testing it at least we'll be able to solve it now 🥲

Once you'll have merged atxr's PR on your repo we'll merge this one, in any case, tks for your contribution!

[OlaPom]

Ok. I think it's done. Thanks for help!

[amtoine]

CI did pass 🥳

[atxr]

Thanks again for contributing! 💯