Skip to content

Latest commit

 

History

History
124 lines (102 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

124 lines (102 loc) · 3.47 KB
Raw

Contribution Guidlines

Welcome to Java A-Z Resources

Contributing

  • Fork this repo
  • Open an issue before working on anything. Will discuss there first.
  • Make changes and make a pull request
  • The changes should reflect in the README contents table according to the given legend below
  • In case of a new topic it should pe present in the Java Syllabus and README contents table
  • Each topic must have one file which should be linked from the Java Syllabus

File Name Guidelines

  • All files must be a markdown file with extension .md

  • File name must be same as topic name with - (dash) instead of spaces

  • File name must be suffixed with a two digit number representing the order in which they appear in the particular section of Java Syllabus

      03TopicName.md      INCORRECT NAME
  03 Topic Name.md    INCORRECT NAME
  03-Topic-Name.md    CORRECT NAME

  • Each section should have a separate folder. Folder naming convention should be same as above.

Content Guidelines

  • The name of the topic should be H1 heading

    ># Topic Name

  • Sub Topics should be H2 heading

    ## Sub Topic

  • Example and Output headings should be H5

    ##### [Example <Number>](path/to/source-code/directory)
##### Output

  • Code should be written with syntax highlighting

        ```java
    //java Code
    ```

  • Source code of examples should be provided in the Examples directory and linked to examples in notes via Example heading.

  • Directory structure of examples should be as following:

    |20-Examples
|   |<Section-Directory-Name-in-order>
|   |   |<Topic-Name-in-order>
|   |   |   |Example-01
|   |   |   |Example-02
|   |   |   .
|   |   |   .
|   |   |   .
|   |   |   |Example-N
|   |   |<Topic-Name-in-order>
|   |   |   |Example-01
|   |   |   |Example-02
|   |   |   |.
|   |   |   |.
|   |   |   |.
|   |   |   |Example-N
|   |<Section-Directory-Name-in-order>
|   |

    For Example

    |20-Examples
|   |.
|   |.
|   |04-Data-Types
|   |   |01-Premitive-Types
|   |   |   |Example-01
|   |   |   |   |Light.java
|   |   |   |Example-02
|   |   |   |   |MyClass.java
|   |   |   |.
|   |   |   |.
|   |   |.
|   |   |.
|   |   |02-Arrays
|   |   |   |Example-01
|   |   |.
|   |   |.
|   |05-Variables

  • Any Java keyword/class name/method name/variable name used in the content must be enclosed within backtick/backquote ``

  • External resources must be added at the end as list

  • Before updating the work done in README one should consider these minimum requiremnts. There should be at least

    • 2 Reading Resource
    • 1 Video Resource
    • 1 Practice/Example/Questions Resource

Commit Message Guidelines

  • If content for new topic is added 
    New: <message>
  • If existing files are changed 
    Update: <message>

Legend

Emoji Meaning Mardown
✔️ Done :heavy_check_mark:
➖ N/A :heavy_minus_sign:
❌ Not Done :x:
⚠️ Review Needed :warning: