Encog Contributor Guide

If you have created an Encog enhancement think it might be a good addition, then I encourage you to contribute the code to Encog. If you would like to discuss the contribution prior to submission, please contact me. I will usually take both examples and core code contributions. If you are changing the core Encog framework, please keep the following in mind:

  • Minimize Breaking Changes - Encog has been around since 2008 and there is a decent amount of published code that makes use of Encog. As a result I am reluctant to accept code that has a high impact on the existing method signatures. If you would like to make such a change, please contact me before submitting.

  • Unit Tests are Good - At a minimum, you should provide a unit test to make sure that your code remains working, even of others (such as me) need to modify it slightly.

  • Examples are Good - How will others use your nice addition if you do not provide an example? If you are simply fixing a bug, this is not necessary.

Given the above, once you are ready to submit your change I suggest a GitHub pull request. This ensures that I make the change, as you intended. You are also credited for the change in GitHub.

Thank you for your interest in contributing to Encog’s code base. If you have any questions, please contact me.