JavaAlgorithms/README.md
2018-08-24 10:30:28 -07:00

1.7 KiB

The Algorithms - Java (WORK IN PROGRESS)

Goal

Make it a working Java project with full fledged test cases for each algorithm and correct package structures. Once we have enough test coverage, we would merge it with master

Contribution Guidelines

  • If you add an algorithm then you have to add a test along with it. In absence of a test the PR would not be approved
  • Follow the correct coding guidelines. Refer DecimalToAnyBase.java for algorithm and DecimalToAnyBaseTest.java for the test coding standards.
  • Please do not add a signature inside the code. The commit history is sufficient enough to determine who has added the code to the repo.
  • Make sure the algorithm which is getting added comes under a certain domain of Algorithms. Please don't create a package with name such as Misc, Others etc.
  • While making a PR make sure you are commiting the Java files only and not any project specific files. If you feel that your IDE is generating some extra files then either don't add them to git or add the extensions to .gitignore
  • Please don't add solutions to problems from online judge such as Hackerrank, Leetcode etc

Steps to raise a PR

  • Fork to Java Repo
  • Open the forked repo on your local machine
  • Switch to Development branch by using the command git checkout Development
  • Make the changes on your local machine
  • Push the changes to the forked repository
  • Raise a PR against the Development branch