Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.24 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.24 KB
Raw

EK Contributing Guidelines

Important

Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.

Issues

  1. Provide product version where the problem was found;
  2. Provide info about your environment;
  3. Provide detailed info about your problem;
  4. Provide steps to reproduce the problem;
  5. Provide actual and expected results.

Code

  1. Check your code before creating pull request;
  2. If tests are present in a project, add tests for your code;
  3. Add inline documentation for your code;
  4. Apply code style used throughout the project;
  5. Create your pull request to develop branch (pull requests to other branches are not allowed).

Screenshots for README

  • Format — PNG optimized with TinyPNG;
  • Width — 888px or 1776px (x2);
  • Maximum size — 1MB.

Usage demo for README

  • Console size — 133 ⨯ 33;
  • Format — GIF optimized with EZGif;
  • Size — 1332px ⨯ 812px;
  • FPS — 12 or 24;
  • Maximum size — 3MB.