- This is not because it is the best style, but because it is easy for contributers to be consistent.
- All code requires heavy commenting.
- Every class and method must be commented with Javadoc.
- Each complex code section of code must be commented.
- Comments must focus on what is being done, why it is being done, why it is being done the way that it is, and in what circumstances it should be done.
- All changes require significant Unit Test coverage, with both positive and negative tests.
- Currently UI and HTTP interface code is exempt from this because it changes frequently.
- If any manual tests are required the Testing Strategy documentation must be updated to include them.
- If the change is visible or meaningful to users the documentation must be updated.
- Copyright of all code additions to the code base must be assigned to CrushPaper.com.
- The GNU FSF also encourages this.
- Of course, anyone is free to maintain their own fork of the code with changes for which they do not assign the copyright to CrushPaper.
- One reason why contributors are asked to assign the copyright of their contribution is that copyright can be enforced only by the copyright holder.
- Another is so that potentially in the future CrushPaper.com can make money from the software similar to how companies such as Neo4j dual license their software under both the GPL and an enterprise license. Hopefully it would benefit all CrushPaper users if CrushPaper contributors are able to make money from CrushPaper.
- Contributors are responsible for ensuring that their employer or school has disclaimed copyright to the contributor's contribution.
Try CrushPaper for free without creating an account!
Or watch the Demo Movie