Neural2d keeps getting better because open source collaboration works. Anyone is welcome to participate.
This is a small project with informal processes. But for those who prefer to see things in writing, here are some guidelines for participating in neural2d development.
- To start a discussion on any topic related to neural2d, consider opening an Issue on the Github project page.
- Also feel free to respond to announcements posted on neural2d.net announcement blog with comments there.
- You can email me at email@example.com.
Bugs reports and enhancement suggestions
We welcome bug reports and enhancement suggestions on the Github issue tracker.
How to submit code
Feel free to suggest code changes. Even if we don’t accept your contribution, the discussion will likely be educational and appreciated.
- Github pull requests are welcome so that everyone can examine the code. Or send code snippets by email. We’re flexible.
- When submitting code, try to follow the prevalent coding and formatting style already in use in the source code. If you submit something that is not formatted consistent with existing style, we can fix the formatting for you.
- New code should be liberally commented. If English is not your strong point, we can clean up the grammar and spelling for you. Besides putting comments in the source code, you can also add comments to an associated Issue, or attach comments to a particular commit, or, for a more conspicuous location, you can add to the neural2d wiki on Github.
- The core of neural2d should be dependent on nothing other than the language itself.
- Before any contribution is accepted, the program must pass all the existing neural2d unit tests. If your contribution changes neural2d’s behavior or specifications, then you should add one or more unit tests to src/unitTest.cpp. Test on as many platforms and compilers as you comfortably can.
Copyrights and licenses
- Neural2d is licensed under the terms of the MIT license. In this project, the sole purpose of copyrights and licensing is to maintain a record of code authorship for the street cred it gets us.
- We allow file-specific copyright notices in individual source files, and we also have an overall copyright and license notice for the entire project. The LICENSE file in the root directory should summarize the overall copyright and file-specific copyrights. All code must be licensed under terms of the MIT license.
- Small changes and bug fixes get absorbed into the overall copyright and license.
- If you contribute a substantial section of new code and want to maintain a copyright on it, then isolate the new code in a separate file, and add a copyright notice at the top of the file like this:
The contents of this file are Copyright 20XX, Your Name.
See the LICENSE file for additional copyrights and license terms.
- If you wish to use any part of neural2d in your own external project or product, you can add an attribution like this after your own copyright notice:
Copyright for portions of this project are held by
[ list the pertinent neural2d authors here ]
as part of project neural2d.