Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.19 KB

Contributing to KonText

Workflow

  • create a fork of the repository
  • create you feature branch from the master branch
    • be sure to keep your repository in sync with upstream
  • once your changes are ready, create a pull request

Coding style

Python code

Client-side code in general

  • any non-JSX code must be written in TypeScript
    • React views use JSX
  • action models/stores are located in public/files/js/tpl
  • React views are located in public/files/js/views
  • plugin-related modules are in public/files/js/plugins
  • use TypeScript/ES6 style modules

TypeScript

  • constructs from versions up to 1.8.x (included) are supported
    • changes in support towards newer versions will be announced here
  • try to minimize use of the any type
  • prefer existing types from ts/declarations/common.d.ts and tpl/document.ts over defining your own ones

License

By contributing to KonText, you agree that your contributions will be licensed under its GNU General Public License version 2.