enarx-archive / enarx.github.io

Enarx.dev website and relevant assets
https://enarx.dev
MIT License
43 stars 27 forks source link

docs: update C.md #151

Closed aryankaushikdev closed 2 years ago

aryankaushikdev commented 2 years ago

🛠️ Fixes Issue

Due to the wrong name of the file, the wasicc command was not working. but after the change in the name, it will work well.

👨‍💻 Changes proposed

There is a minor change in the file name, which will help to execute the wasicc command.

📷 Screenshots

Screenshot from 2022-03-31 03-10-29

aryankaushikdev commented 2 years ago

Hi Nick Sir, Can you please help me to understand where exactly my pull request is making an error.

Regards

nickvidal commented 2 years ago

Hi @aryankaushik-git, thank you for this. All is fine, the only issue is that we are using conventional commits. If you could make this small change please, it will work:

https://enarx.dev/docs/Contributing/PRs#commit-messages

aryankaushikdev commented 2 years ago

@nickvidal sir, I'm working on it.

Deepansharora27 commented 2 years ago

@aryankaushik-git This is not a bug this is a typo mistake. You can name your source code file as per your convention and generate a output file which then can be converted to a WASM Binary

aryankaushikdev commented 2 years ago

@Deepansharora27 yeah you are right. But when someone is just following the doc and copying as it is, can waste a lot of time. I personally while executing the code wasted a lot of time figuring out what was wrong, that's why I thought it need some correction.

Deepansharora27 commented 2 years ago

@aryankaushik-git Though it's better to not copy and paste directly into your editor since that way you will not be able to retain the concept in a better way in your mind(that's what personally I believe). But Anyways, Good Work fixing the typo. Also, you could have amended the commit message like this: docs: fix typo in C Docs, since the WebAssembly guide has been already created and it is a typo fix

@nickvidal Nick will be able to throw light on this in a better way since I learned this by Observing Nick and the neat and clean way in which he structures his commit messages

aryankaushikdev commented 2 years ago

@Deepansharora27 I understand the concern you mentioned and it is a genuine one but for every beginner, documentation matters a lot. That's why I thought there should be a change for this typo. But I really want to appreciate your effort in creating such guides for various languages.

Deepansharora27 commented 2 years ago

@Deepansharora27 I understand the concern you mentioned and it is a genuine one but for every beginner, documentation matters a lot. That's why I thought there should be a change for this typo. But I really want to appreciate your effort in creating such guides for various languages.

I Appreciate Your Efforts❤️ Great Work on Observing the typo error and reporting it