Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Latest commit

 

History

History
53 lines (33 loc) · 5.49 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 5.49 KB
Raw

Steps for contribution

  1. Fork the repo

  2. Clone the forked repo into your local machine 

$ git clone https://github.com/your_username/hacktoberfest-java.git
  1. cd to the repo
 $ cd hacktoberfest-java
  1. Create a branch
    $ git checkout -b mybranch

  1. Open the repo code using any IDE/text-editors

  2. There are different packages for topics such as file, oop, generics, collections and exceptions. Write a program under your desired topic.

  3. Add, Commit and Push the changes to your forked repo

$ git add .

$ git commit -m "your commit message"

$ git push origin mybranch
  1. Create a pull request from mybranch of your forked repo to main branch of this(upstream) repo.

Naming Conventions

Name the packages, classes, interfaces, variables, methods and constants following the convention.

Identifier Type Rules for Naming Examples

Packages

 The prefix of a unique package name is always written in all-lowercase ASCII letters and should be one of the top-level domain names, currently com, edu, gov, mil, net, org, or one of the English two-letter codes identifying countries as specified in ISO Standard 3166, 1981.

Subsequent components of the package name vary according to an organization's own internal naming conventions. Such conventions might specify that certain directory name components be division, department, project, machine, or login names.

 com.sun.eng

com.apple.quicktime.v2

edu.cmu.cs.bovik.cheese
Classes Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML). class Raster;
class ImageSprite;
Interfaces Interface names should be capitalized like class names. interface RasterDelegate;
interface Storing;
Methods Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized. run();
runFast();
getBackground();
Variables Except for variables, all instance, class, and class constants are in mixed case with a lowercase first letter. Internal words start with capital letters. Variable names should not start with underscore _ or dollar sign $ characters, even though both are allowed.

Variable names should be short yet meaningful. The choice of a variable name should be mnemonic- that is, designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary "throwaway" variables. Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters.

 

int             i;

char            c;
float           myWidth;
Constants The names of variables declared class constants and of ANSI constants should be all uppercase with words separated by underscores ("_"). (ANSI constants should be avoided, for ease of debugging.) static final int MIN_WIDTH = 4;

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

Reference: https://www.oracle.com/java/technologies/javase/codeconventions-namingconventions.html