Thanks for wanting to contribute to this project. Here are the steps for contributing-
-
Raise an issue stating the bug fixes/enhancements you want to make.
-
Open a pull request for the issue.
-
Properly fill the pull request template. Make sure the code is properly formatted and proper documentation has been added. You will need to enter @param and @return feilds for every method.
-
Once you make your change, you will require to test all old features mentioned in the main class by running either this code or running any other code which tests the present functionality with the following parameters.
- MNIST OCR database
- 45000 train samples for 10 epochs
- 9900 test samples
- Learning rate 1
- Batchsize 10
-
You will also be required to test the functionality you added if any by running test drive code similar to this sample. The test drive must have the above parameters.
-
The output files of both the testing of old functionality and new functionlity need to be submitted in the pull request.
-
Your pull request will be reviewed and will be merged if it meets the requirements in due course of time.
Your pull request may not be accepted beacuse of the following reasons
- The pull request template is not filled.
- Relevant documentation to the code is not provided.
- Old funtionality after the change is not tested.
- New functionality (if any) is not tested.
- The code is unreadable and does not meet clean code standerds like proper variable nameing and comments.
- The functionality is not required at all and is counterproductive. (This will be stated in step 1 after raising the issue.)