|
| 1 | +## Summary |
| 2 | + |
| 3 | +First of all let me say that we are very glad to have any contributions to the library; as the more people developing and |
| 4 | +looking over and testing it, the more likely it is to be stable and succeed. I'm not one for liking hard and fast rules, |
| 5 | +but like any community a few rules are needed in order to ensure things go smoothly. |
| 6 | + |
| 7 | +* Don't start working on any large features without creating an issue first, this allows for feedback before proceeding, |
| 8 | + potentially avoiding a lot of wasted time later. |
| 9 | +* Please try and use a similar code style to the rest of the project. At an absolute minimum please keep fields, |
| 10 | + variable styles and braces the same. Use camel case for all variables. Functions should always start with a lower |
| 11 | + case letter. Classes always start with an upper case letter. |
| 12 | +* Please be sure that you're happy with the licensing model of this project. For any files you create, you can retain |
| 13 | + copyright, but they must be provided under the same Apache as the rest of the project, and with copyright granted to |
| 14 | + the library at the top of the file. |
| 15 | +* If you edit keywords.txt, be exceptionally careful that tabs have not been replaced as spaces. |
| 16 | +* If using Arduino: Please make sure that compiler warnings are set to All, (Arduino Menu -> Preferences -> Compiler warnings) |
| 17 | +* If using platformIO (recommended): See [https://github.com/davetcc/tcLibraryDev] |
| 18 | + |
| 19 | +## Why do all TheCodersCorner libraries use an Apache license? |
| 20 | + |
| 21 | +The apache license allows others to use this library commercially. You may ask why that is important, it is important |
| 22 | +because any strong and stable ecosystem, such as Java, has got where it is because it's used by the Hobbyist, the |
| 23 | +Enterprise, start-ups and just about any other group you care to mention. |
| 24 | + |
| 25 | +I think it's a shame that so many Arduino libraries are GPL instead of Apache, LGPL or MIT; as it means these can't be used |
| 26 | +by commerical entities, at least without contacting the vendor of the library first. Will they bother to do that, NO, they |
| 27 | +will just write what they need to get the job done and probably never give it back. If the library were open, and this |
| 28 | +same commerical made changes, they could well decide to give them back! |
0 commit comments