Implementation of Language specific guidelines

[lulucca12]

Related closed issues: #152 #18 #12 #25.
In my opinion, we should consider adding good practices, links to linter and prettifiers and general styling rules, like using spaces instead of tabs for indentation and how many spaces to each language.
But this could be a good place to define a way to contribute in relation to writing the chapter's text, like in #25, as, for now, we have to wait for @leios working on it and there is not a defined way of writing and submitting PR in respect of this.

• Start writing a How to Contribute section
• Make language-specific subsections as we think about them
• Make a general section for defining common styles and list "Prettifiers" and "linters"
• Add PR and Issues templates

[leios]

@lulucca12 I agree. Something like this is useful. Maybe we should have a page for each language in the wiki?

[jiegillet]

I think a page per language is excessive, unless we're talking about C++ 😛

[leios]

Fair enough. I know @julianschacher and @Butt4cak3 were both talking about adding more to the How to Contribute section.

[lulucca12]

I think we should list some TODOS for closing this issue and add them separately, one in each PR. Something like this:

• Start writing a How to Contribute section
• Make a list of "Prettifiers" and "linters"
• Make a general section for defining common styles
• Make language-specific subsections as we think about them
• Add PR and Issues templates

And we could add more.

[june128]

I'm currently working on the How to Contribute section, so that will come in the following days.
I also thought about PR and Issue templates, the question is, if they scare people and if they provide a real benefit, so that's something to discuss.

[lulucca12]

I think we should create simple and non-intrusive templates that should be just a way of getting started, for people that face the problem of the blank page, doesn't know how to start making the first issue/PR but not so complex that they feel intimidated.

[Butt4cak3]

• Start writing a How to Contribute section

As Julian already said, he's working on that and I'm also working on a video series on the topic. In addition to that, I did a live stream to show the process and answer some questions, but that one didn't go too well.

• Make a list of "Prettifiers" and "linters"
• Make a general section for defining common styles

I'd combine these two. They're so closely linked that it makes sense to first outline the code style and then recommend some linters for it. If possible, we should also add linting configurations to the repository.

Other than that, I agree on these points. You might want to move the checklist to the top post for visibility, @lulucca12.

[lulucca12]

@Butt4cak3 Do you have a schedule or you do the streams occasionally? I follow you on Twitch and I couldn't watch it. I agree with the idea of streaming the process of contributing to the Archive and I think it should be done by more people.

[Butt4cak3]

@lulucca12 I'm not a streamer. I stream things occasionally, when I feel like it. I was thinking about trying the contribution stream thing again because I think it failed in part because it was too spontaneous. If there's a next time, it will be announced somewhere beforehand.

[june128]

@lulucca12 You can check the first point. The How to Contribute section is being worked on by me.

[june128]

How to Contribute section: https://github.com/algorithm-archivists/algorithm-archive/wiki/How-to-Contribute
and a video playlist by @Butt4cak3 : https://www.youtube.com/playlist?list=PL5NSPcN6fRq2vwgdb9noJacF945CeBk8x

[lulucca12]

@julianschacher @Butt4cak3 This section is nice, thanks for creating resources for making the contribution more easy for me and for others 😄

[june128]

You're welcome; I hope it does help!
If you find anything that's unclear, have any questions or suggestions, please let me know.