- 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
- PEP8 Style Guide
- line length of 100 characters
- except for unit/integration tests, everything should be written in TypeScript
- any asynchronous code should be based on RxJS (i.e. no async/await, no Promise etc.)
- state management and binding to components is realized via kombo framework
- array and object manipulation is done via cnc-tskit
- locations:
- most general types are stored in
public/files/js/types - application models are located in
public/files/js/models - React views are located in
public/files/js/views - plugin-related code is in
public/files/js/plugins
- most general types are stored in
- we roughly stick with the latest version of TS (currently, it's 4.4.x)
- we do not use
strictNullChecks(yet) but we strongly encourage you to define types in a compatible way - do not use any type (if necessary use
unknown)
To run integration tests, Docker and Docker Compose must be installed
- create required images
docker-compose -f docker-compose.yml -f docker-compose.cypress.yml --env-file .env.mysql build
- run the application
docker-compose -f docker-compose.yml -f docker-compose.cypress.yml --env-file .env.mysql up
- run Cypress
./node_modules/.bin/cypress open
- Use Cypress GUI to run the tests
Once containers are installed and rut at least once, a clean-up should be performed before each testing:
docker-compose -f docker-compose.yml -f docker-compose.cypress.yml down --volumes
By contributing to KonText, you agree that your contributions will be licensed under its GNU General Public License version 2.