Skip to content
Menaka Jayawardena edited this page Apr 2, 2016 · 7 revisions

The code should be structured as follows Official repository for the Hackers' Club code base.

Language Prefer any language. (Java, C, C++, JS, python etc)

  • The implementation should be clear and error free.
  • Use separate folder for each algorithm and name of the folder should be the nam of the algorithm and language. Ex: quick_sort_java, djkstra_C, bst_python
  • Use variable names and methods which describe the purpose
  • All the methods and variables must be explained well. Use comments as defined in the language used.
  • On top of the each code file, add your credentials.

Always try to follow the best coding practices. It will help you to write a clear and understandable code and others could easily understand it.

Licensing

The code is Licensed with Apache License 2. For every code you write, add the following license header and modify the , and

/* *Copyright <Year> Hackers' Club, University Of Peradeniya * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * Author : <Your Name> <E Number> */

Happy Coding.....!!!

Clone this wiki locally