Skip to content

contributing.md

Latest commit

 

History

History
111 lines (108 loc) · 3.83 KB

contributing.md

File metadata and controls

111 lines (108 loc) · 3.83 KB

Contributing F.A.Q.

  1. Follow EO principles
  2. Use @todo #/DEV labels for all todo tasks. Its allows 0pdd to create the issues.
  3. Run mvn clean package -Pqulice before commit. All issues related to your code should be fixed before commit.
  4. Each class should have the javadocs with these tags @author, @version, @since. For example, 
      /**
   * .
   *
   * @author Yurii Dubinka (yurii.dubinka@gmail.com)
   * @version $Id$
   * @since 1.0.0
   */
  public final class Args {   
  ...
    You can configure such template in your IDE. For IntelliJ IDEA:
    • File > Settings > Editor > File and Code Templates > Includes > File Header
    • Put the following text (change name, email and version accordingly) 
       /**
  *
  * .
  *
  * @author Yurii Dubinka (yurii.dubinka@gmail.com)
  * @version $Id$
  * @since 1.0.0
  */
    • Specify your name and email
    • Press Apply, OK.
  5. Settings > Editor > Code Style
    • Change Hard wrap at to 80
    • Change Line separator to Unix and OS X (\n)
    • Press Apply > OK
  6. Settings > Editor > Code Style > Java > Wrapping and Braces
    • Enable Ensure right margin is not exceeded tick
  7. Settings > Editor > Code Style > Java > Wrapping and Braces > Method declaration parameters
    • Disable Align when multiline tick
    • Press Apply > OK
  8. Settings > Editor > Code Style > Java > JavaDoc
    • Disable Generate "<p>" on empty lines
  9. Settings > Editor > Code Style > Java > Blank Lines
    • Set In declarations equal to 0 in section Keep Maximum Blank Lines
  10. Settings > Editor > Code Style > Java > Imports
    • Set the following order for Import Layout section 
      import java.*
import javax.*
import all other imports
import static all other imports
    • Change Class count to use import with '*' to 20
    • Change Names count to use static import with '*' to 20
  11. Settings > Editor > Сopyright > Formatting > Java
    • Select Use custom formatting options
    • Select Separator before with Length equal to 1
    • Disable Add blank line after
  12. Settings > Editor > Code Style > Java > Tabs and Indents
    • Change Continuation Indent to 4
    • Press OK
  13. Settings > Editor > Copyright > Copyright Profiles > Add new with name default >
  14. Settings > Editor > Code Style > Java > Code Generation
    • Select option "Make generated local variables final"
    • Select option "Make generated parameters final"
  15. Settings > Editor > Code Style > Java > Spaces
    • Select Array initializer braces
    • Press Apply > OK
  16. Settings > Editor > File and Code Templates > Includes
    • Press +, name = Unit-test File Header, extension = java
    • Add text like below (change name, email and version accordingly) 
       /**
  * Unit tests for class {@link }.
  * 
  * @author  Yurii Dubinka (yurii.dubinka@gmail.com)
  * @version $Id$
  * @since   1.0
  * @checkstyle JavadocMethodCheck (500 lines)
  */
  @SuppressWarnings("PMD.AvoidDuplicateLiterals")
    • Press Apply
    • Settings > File and Code Templates > Includes > Code
    • Change JUnit4 Test Class to 
          ...
    #parse("Unit-test File Header.java")
    ...
    • Change JUnit5 Test Class to 
          ...
    #parse("Unit-test File Header.java")
    ...
    • Press OK
  17. Settings > Editor > General > Appearance
    • Disable Show parameter name hints
    • Press Apply > OK
  18. Settings > Editor > General > Code Folding
    • Disable One-line methods
    • Press Apply > OK