MVIS-Team / MVISGuidance

https://mvisguidance.com
0 stars 0 forks source link

Follow coding conventions #19

Open HanchaiN opened 1 year ago

HanchaiN commented 1 year ago

As stated in Django's official documentation, there're coding conventions that developers should follow. This can help organize the code and make it easier to navigate, especially when multiple parties collaborate. While some of them are currently enforced, some are not. This issue is filed so that the old code is reformatted/refactored and that new developers are informed of the conventions.

HanchaiN commented 1 year ago

Apart from the official recommendation, the following concepts are recommended.

However, using automatic checkers may not work. There are instructions for tools to ignore the errors all over the place due to bodging. Plus, configuration files for the development container instruct the checkers to ignore the errors. While this is a simple task, it requires work. I recommend you use find-and-replace tools to remove the instructions and configure all the tools. Those tools not only detect errors, but some can also fix the error for you.