Skip to content

Contribute

Ramon edited this page May 15, 2018 · 5 revisions

Translate

You can help us translate this app into your native language by visiting SkyTube's Weblate page. Just log in using your GitHub/GitLab/BitBucket/Google/Facebook account and start translating!

Translation status:

Translation status

Developers Guidelines

  • Follow the Java Code Conventions.
  • Each class and method shall be properly documented.
  • Code shall be maintainable -- no code copy and pasting.
  • Use tabs to indent code. Each tab shall be equivalent to 4 spaces.
  • Before you start developing, please open an issue and propose what you are willing to implement (unless a ticket has already been opened).

Code Example:

/**
 * A detailed description of what this class does.
 *
 * <p>Feel free to write multiple paragraphs of comments.</p>
 */
public class Player {

	/** Instance variable description */
	private String name;
	/** Instance variable #2 description */
	private String surname;


	/**
	 * Describe this method.
	 *
	 * @param name     Player's name.
	 * @param surname  Player's surname.
	 */
	public Player(final String name, final String surname) {
		// add comments (especially if logic is not straightforward)
		this.name = name;
		this.surname = surname;

		// ...etc.
	}


	/**
	 * Instance method names should be intuitive and describe what their
	 * function is.  Horizontally, comment lines should not exceed 80 characters.
	 * 
	 * <p>Methods should be separated by 3 new lines.</p>
	 */
	public void processPlayer() {
		// description
		if (condition) {
			this.name = "hello";
		}
	}

	// ...etc.

}

Submit a Pull Request

  1. Fork the app.
  2. Clone the repository:
$ git clone https://github.com/YOUR-USERNAME/SkyTube.git
$ cd SkyTube
  1. On your workstation, create a new branch: git checkout -b my-branch-name
  2. Write the code changes and git commit them.
  3. Rebase your branch.
  4. git push to your fork and submit a pull request.
Clone this wiki locally