ali-ghn / golearning

Go Learning is a set of go modules which helps me learn go as fast as possible

Ali Ghasem Nejad

Contact Information

📧 Email : [email protected]

☎️ Phone Number: +(98) 937-812-3279

Description

Hello there, I'm Ali Ghasem Nejad, a software engineer, I love coding and learning more about new technologies.

Statics

golearning's Issues

Adding `READMED.md` file to each learning module for better understanding the subject

Is your feature request related to a problem? Please describe.
As each learning module represents a subject in Golang, a README.md file can be handful in each module so there is more explanation about the subject.

Describe the solution you'd like
An implementation of README.md file in each learning-xx module.

Describe alternatives you've considered
There is a bit of documentation in the main function in module but for the sake of ease-of-access this approach is relativity better.

Additional context
A structured README.md file is a better approach than just putting all the information there.
The suggested way of writing README.md file in each learning module is
1- Heading: what is the subject of the module ?
2- Small description: a small description about the subject and why its useful so the reader can decide whether the subject is useful for them or not.
3- Full explanation: full explanation about the subject.
4- Examples: examples are a good way of helping developers to understand the subject.