General Coding Guidelines
Coding Guidelines is a material designed to help programmers. This material is indicative and should be read before a creator builds a challenge.
The Challenge code does not only have to pass the verification tests on the platform, it must also be stable, easy to understand and easy to maintain.
INFO
No guideline applies to every type of code or every scenario. Sometimes guidelines are difficult to apply, especially if the code is written before reading the rules, so try as much as possible to ensure that the code is by the guidelines.
Each code should be correct, do not forget that the codes are made for users from beginners to advanced. Try to make the code qualitative.
- Every detail matters! Each snippet must be well written. Even if some parts are not visible to the user, this does not mean that they must not be correct or do not respect the basic rules.
- Coding language! Keep the rules of the chosen coding language. Follow and keep coding rules, standard names and best practices.
- Master your work! Make sure you master the subject and know exactly what you want to ask for and what to expect.
- Think about the future! Write maintainable code, the code will always be updated when it's the case. That's why you need to write maintainable code.
- Stick to the rules! Try to stick to the rules commonly recognized for your language.
- Respect the standard! Respect widely-recognized standards and conventions related to software design and programming. Avoid antipatterns and bad practices.
- Help! You can help the users by adding comments with subjects that you may think help solve the code challenge.