Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 1.84 KB

How to contribute to Kaiju Engine

Did you find a bug?

  1. Search issues, both open and closed first
  2. If you didn't find the bug, report it via issues with bug tag

Pull requeset rules

  1. You must make a pull request to the staging branch
  2. Title must be short and self explanitory
  3. Give a detailed description of the change, why it was made, and what it solves
  4. Pull request title should include issue number (eg: #1234)
  5. You can provide a video of your entire development process of the PR (see video rules below)
    • Provide your video(s) as a downloadable link
    • Include your name and a picture you wish to use for credit
      • If not provided, your GitHub username/profile picture will be used

Video rules (if you provide a video)

  • In your video, the text/code must be legible
  • Maximum video quality is 1080p 30fps
  • You must provide verbal or code comment commentary showing your thought process
    • You can talk the whole video if you wish, you can also try to be funny, but ALWAYS stay on topic of the code/PR
  • No fancy editing required unless you want to
    • Bare minimum is just hit record, do the code, stop recording
  • Time stamps for major parts of the process would be appreciated, but not required
  • Pause recordings or cut out useless sections of video that don't present any meaningful insight or process
    • Example: You reading a web page or watching a video to learn something
      • You can just summarize or reference what you used for reference
  • Do not include other people's videos, music, faces, or any copywritten information in your video
  • You are responsible for anything visible on your screen, don't share sensitive information
  • Your video must comply 100% with YouTube's video guidelines

Thanks! ❤️ ❤️ ❤️

Kaiju Team