Git Product home page Git Product logo

Comments (2)

daredevildave avatar daredevildave commented on May 14, 2024

Generally speaking anything included in the API reference is the public API. The API docs are automatically generated from the stable branch, so should always match the current latest engine.

Regarding internal code:

Private methods/vars should be be prefixed by _
Work-in-progress functionality may be included, but should not be documented.
Released code should always be documented and included in the API reference.

I'm working on a CONTRIB file which will include details of how to submit patches and I'll include a coding standards section in that too.

from engine.

daredevildave avatar daredevildave commented on May 14, 2024

Added a contributor file.

Anything else we can add to help here?

from engine.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.