Documenting Backend code conventions

[canberkboun9]

Description:

Coding conventions help the developing team to understand each other's code and communicate ideas. The benefits of these rules can be seen more effectively in a large team. We have 4 people in the backend team. It is not such a big team, but some code convention might be reasonable to have.

Todo's:

• Create a page for the backend code conventions
• Create the conventions, edit the page.

Reviewer: @oguzhandemirelx

Task Deadline: 30.10.2022 23:00
Review Deadline: 31.10.2022 23:00

[canberkboun9]

• Created the page, and conventions in it.
• Added it to the Sidebar.

[oguzhandemirelx]

Excellent job, Canberk. I think we can add [Error 500 - Internal Server Error] to our error handling part because we will probably encounter them too. Also, we can add comment conventions for the backend team to our page.

[mehmetemreakbulut]

Great! Also, we can add code style and conventions from official Django documentation as a relevant link.

[canberkboun9]

Excellent job, Canberk. I think we can add [Error 500 - Internal Server Error] to our error handling part because we will probably encounter them too. Also, we can add comment conventions for the backend team to our page.

Thanks, I will add the error code. Comments should not be considered as documentation examples, I think. Too much of them and some unnecessary ones make the code cluttered. And the convention should be to write them in the code to translate complex parts. We can add some details about commenting, like:

• We should write comments in a new line under the code line we prefer.
• Comments should end with a ".".

Also, we can use some documentation tools generating documentation from comments over functions etc. I forgot the name now.

Great! Also, we can add code style and conventions from official Django documentation as a relevant link.

Nice suggestion, but, can you add it like in your mind? I don't know which parts to add.

[mehmetemreakbulut]

Excellent job, Canberk. I think we can add [Error 500 - Internal Server Error] to our error handling part because we will probably encounter them too. Also, we can add comment conventions for the backend team to our page.

Thanks, I will add the error code. Comments should not be considered as documentation examples, I think. Too much of them and some unnecessary ones make the code cluttered. And the convention should be to write them in the code to translate complex parts. Also, we can use some documentation tools generating documentation from comments over functions etc. I forgot now.

Great! Also, we can add code style and conventions from official Django documentation as a relevant link.

Nice suggestion, but, can you add it like in your mind? I don't know which parts to add.

Yes, I added the relevant links that we use.

[canberkboun9]

I added the comment conventions, I think we can close the issue.

[oguzhandemirelx]

Yes, everything looks good. Thanks for your effort.