diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..e2557e35a09 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,196 @@ +# Contributing guidelines + +We adhere to the [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) found below. + +### Want to add a new feature? + +- avoid pushing new features directly (also [consider no upstream pushing](docs/no-upstream-push.md)) +- [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) to your private github +- create a new branch with a name meaningful for the feature at hand +- [create a Draft Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) with `WIP:` in its name to the `master` branch (example: `WIP: documentation updates`) +- commit all your work to your new branch; other developers can provided feedback by reviewing your pull request +- when the feature is ready: remove the `WIP:` and set it ready to review +- when your changes get approved, remember to always select **Squash and merge** from the drop-down button + +New features are merged when CI is passing and two other members approve your pull request. + +### CI notes + +For GitHub Actions, the CI needs to pull and push docker images to a repository. Using +[docker hub](https://hub.docker.com) is advised. +New registries will be created and images will be pushed and pulled during builds. Have a look +at [docker-compose-build.yml](services/docker-compose-build.yml) for a full list of names. +To avoid collisions make sure the names of the services are not used by your other projects. + + +To enable GitHub Actions on your forked repository: + +- go to the `Actions` page and enable them +- go to the repo's `Settings` page and the click on `Secrets` +- you have to add the following: + - `DOCKER_USERNAME` docker hub username + - `DOCKER_REGISTRY` docker hub username + - `DOCKER_PASSWORD` docker hub access token **(avoid using your password)** + +### Code styles and conventions + +Current setup: [ESLint](https://eslint.org) for `JavaScript` and [Black](https://black.readthedocs.io/en/stable/) + [Pylint](https://www.pylint.org) for `Python`. Have a look in the project root for individual configuration files. + +Read more at [Coding Conventions and Linters](docs/coding-conventions.md). + +### FAQ + +**Q:** I have strange database errors, but I did not change anything. What could I try? +**A:** After starting the application, apply Postgres migrations, run `make help` in project root for details. + +**Q:** I am new to the project, how do I view all available commands? +**A:** Run `make help` in the directory containing a `Makefile`. Usage will be shown. Don't be afraid to read the file, it is quite strait forward and well documented. + +**Q:** My pull request's CI is failing to push/pull images from Docker Hub? +**A:** Check your settings again, [see CI-notes](#ci-notes) and retry. + +**Q:** It is not clear how dependencies work. Where can I read more? +**A:** [Management of python dependencies](docs/python-dependencies.md) has a detailed explanation and useful resources. + +**Q:** I see and `api` folder full of text files, what is it? +**A:** Look at [APIs development guidelines](api/README.md) it will point you in the right direction. + +**Q:** Do you need to commit something (maybe work in progress) and it makes no sense to have the CI run it? +**A:** Add `[ci skip]` in any part of your commit message. The CI will not run get started. + +**Q:** I don't have a good understanding of the aims of the project. Where can I read more? +**A:** [D1.1 Technical Specs. & Technology Evaluation](https://osparc-docs.readthedocs.io/en/latest/) is extensive, but explains the decision making behind most of the code. Please consider reading it. Afterwords you can better grasp the [Computational backend](docs/comp-services.md) description. + +**Q:** Can I have some sort of introduction video about the project? +**A:** Have a look at the following videos, targeted for wider audiences: [What is the SPARC program?](https://www.youtube.com/watch?v=IrZS_IHgrcE&feature=emb_title), [Ideas Lab Introduction to o²S²PARC](https://www.youtube.com/watch?time_continue=11&v=Q96jyFgSFHc&feature=emb_title) and [SPARC Webinar: Introduction to o²S²PARC](https://www.youtube.com/watch?v=vrdVealYydE&feature=emb_title) + +--- + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[code-of-conduct@osparc.io](mailto:code-of-conduct@osparc.io). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md index 3e2f3f39102..2a29c983a73 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,113 @@ -# osparc-simcore platform - -**WARNING** This application is **still under development**. - - -[`master`](https://github.com/itisfoundation/osparc-simcore/tree/master) -[![Code style: black]](https://github.com/psf/black) -[![Requires.io]](https://requires.io/github/ITISFoundation/osparc-simcore/requirements/?branch=master "State of third party python dependencies") -[![travis-ci]](https://travis-ci.org/ITISFoundation/osparc-simcore "State of CI: build, test and pushing images") -![Github-CI Push/PR](https://github.com/ITISFoundation/osparc-simcore/workflows/Github-CI%20Push/PR/badge.svg) -[![coveralls.io]](https://coveralls.io/github/ITISFoundation/osparc-simcore?branch=master) -[![codecov.io]](https://codecov.io/gh/ITISFoundation/osparc-simcore) -[![github.io]](https://itisfoundation.github.io/) -[![itis.dockerhub]](https://hub.docker.com/u/itisfoundation) - - - - -[Code style: black]:https://img.shields.io/badge/code%20style-black-000000.svg -[Requires.io]:https://img.shields.io/requires/github/ITISFoundation/osparc-simcore.svg -[travis-ci]:https://travis-ci.org/ITISFoundation/osparc-simcore.svg?branch=master -[github.io]:https://img.shields.io/website-up-down-green-red/https/itisfoundation.github.io.svg?label=documentation -[itis.dockerhub]:https://img.shields.io/website/https/hub.docker.com/u/itisfoundation.svg?down_color=red&label=dockerhub%20repos&up_color=green -[coveralls.io]:https://coveralls.io/repos/github/ITISFoundation/osparc-simcore/badge.svg?branch=master -[codecov.io]:https://codecov.io/gh/ITISFoundation/osparc-simcore/branch/master/graph/badge.svg - - - -## Overview - -simcore-stack when deployed locally: - -![](docs/img/.stack-simcore-version.yml.png) - -## Usage - -```bash - # clone repo - git clone https://github.com/ITISFoundation/osparc-simcore.git - cd osparc-simcore - - # show setup info and build core services - make info build - - # starts swarm and deploys services - make up-prod - - # display swarm configuration - make info-swarm - - # open browser in: - # localhost:9081 - simcore front-end site - # - xdg-open http://localhost:9081/ - - # stops - make down -``` - -## Requirements - -To build and run: - -- docker -- make >=4.2 -- awk, jq (optional tools within makefiles) - -To develop, in addition: - -- python 3.6 (this dependency will be deprecated soon) -- nodejs for client part (this dependency will be deprecated soon) -- [vscode] (highly recommended) - -This project works and is developed mainly under **linux** but, with some adjustments, it can also be done under windows (see notes below). - -##### Setup for **windows** - -In windows, it works under [WSL] (windows subsystem for linux). Some details on the setup: - -- [Install](https://chocolatey.org/docs/installation) [chocolatey] package manager - - ``choco install docker-for-windows`` - - ``choco install wsl`` or using [instructions](https://docs.microsoft.com/en-us/windows/wsl/install-win10) -- Follow **all details** on [how to setup flawlessly](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly) docker for windows and [WSL] - - -## Releases - -- [Git release workflow](ops/README.md) -- Public [releases](https://github.com/ITISFoundation/osparc-simcore/releases) -- Production in https://osparc.io -- [Staging instructions](docs/staging-instructions.md) - - - - - -[chocolatey]:https://chocolatey.org/ -[vscode]:https://code.visualstudio.com/ -[WSL]:https://docs.microsoft.com/en-us/windows/wsl/faq +# osparc-simcore platform + +**WARNING** This application is **still under development**. + + +[`master`](https://github.com/itisfoundation/osparc-simcore/tree/master) +[![Code style: black]](https://github.com/psf/black) +[![Requires.io]](https://requires.io/github/ITISFoundation/osparc-simcore/requirements/?branch=master "State of third party python dependencies") +[![travis-ci]](https://travis-ci.org/ITISFoundation/osparc-simcore "State of CI: build, test and pushing images") +![Github-CI Push/PR](https://github.com/ITISFoundation/osparc-simcore/workflows/Github-CI%20Push/PR/badge.svg) +[![coveralls.io]](https://coveralls.io/github/ITISFoundation/osparc-simcore?branch=master) +[![codecov.io]](https://codecov.io/gh/ITISFoundation/osparc-simcore) +[![github.io]](https://itisfoundation.github.io/) +[![itis.dockerhub]](https://hub.docker.com/u/itisfoundation) + + + + +[Code style: black]:https://img.shields.io/badge/code%20style-black-000000.svg +[Requires.io]:https://img.shields.io/requires/github/ITISFoundation/osparc-simcore.svg +[travis-ci]:https://travis-ci.org/ITISFoundation/osparc-simcore.svg?branch=master +[github.io]:https://img.shields.io/website-up-down-green-red/https/itisfoundation.github.io.svg?label=documentation +[itis.dockerhub]:https://img.shields.io/website/https/hub.docker.com/u/itisfoundation.svg?down_color=red&label=dockerhub%20repos&up_color=green +[coveralls.io]:https://coveralls.io/repos/github/ITISFoundation/osparc-simcore/badge.svg?branch=master +[codecov.io]:https://codecov.io/gh/ITISFoundation/osparc-simcore/branch/master/graph/badge.svg + + + +## Contributing + + +Would you like to make a change or add something new? Please read the [contributing guidelines](CONTRIBUTING.md). + + +## Overview + +simcore-stack when deployed locally: + +![](docs/img/.stack-simcore-version.yml.png) + +## Usage + +```bash + # clone repo + git clone https://github.com/ITISFoundation/osparc-simcore.git + cd osparc-simcore + + # show setup info and build core services + make info build + + # starts swarm and deploys services + make up-prod + + # display swarm configuration + make info-swarm + + # open browser in: + # localhost:9081 - simcore front-end site + # + xdg-open http://localhost:9081/ + + # stops + make down +``` + +## Requirements + +To verify current base OS, Docker and Python build versions have a look at: +- Travis CI [config](.travis.yml) +- GitHub Actions [config](.github/workflows/ci-testing-deploy.yml) + +To build and run: + +- docker +- make >=4.2 +- awk, jq (optional tools within makefiles) + +To develop, in addition: + +- python 3.6 (this dependency will be deprecated soon) +- nodejs for client part (this dependency will be deprecated soon) +- swagger-cli (make sure to have a recent version of nodejs) +- [vscode] (highly recommended) + +This project works and is developed under **linux (Ubuntu recommended)**. + +##### Other OSes setup + +When developing on these platforms you are on your own. + +In **windows**, it works under [WSL] (windows subsystem for linux). Some details on the setup: + +- [Install](https://chocolatey.org/docs/installation) [chocolatey] package manager + - ``choco install docker-for-windows`` + - ``choco install wsl`` or using [instructions](https://docs.microsoft.com/en-us/windows/wsl/install-win10) +- Follow **all details** on [how to setup flawlessly](https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly) docker for windows and [WSL] + +In **MacOS**, [replacing the MacOS utilities with GNU utils](https://apple.stackexchange.com/a/69332) might be required. + +## Releases + +- [Git release workflow](ops/README.md) +- Public [releases](https://github.com/ITISFoundation/osparc-simcore/releases) +- Production in https://osparc.io +- [Staging instructions](docs/staging-instructions.md) + + + + + +[chocolatey]:https://chocolatey.org/ +[vscode]:https://code.visualstudio.com/ +[WSL]:https://docs.microsoft.com/en-us/windows/wsl/faq diff --git a/ci/github/helpers/setup_docker_compose.bash b/ci/github/helpers/setup_docker_compose.bash index 62209060d0e..6d11472706a 100755 --- a/ci/github/helpers/setup_docker_compose.bash +++ b/ci/github/helpers/setup_docker_compose.bash @@ -3,6 +3,11 @@ set -euo pipefail IFS=$'\n\t' +# when changing the DOCKER_COMPOSE_VERSION please compute the sha256sum on an ubuntu box (macOS has different checksum) DOCKER_COMPOSE_VERSION="1.25.3" +DOCKER_COMPOSE_SHA256SUM="b3835d30f66bd3b926511974138923713a253d634315479b9aa3166c0050da98" curl -L "https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose -chmod +x /usr/local/bin/docker-compose \ No newline at end of file +chmod +x /usr/local/bin/docker-compose + +# https://superuser.com/a/1465221 +echo "$DOCKER_COMPOSE_SHA256SUM /usr/local/bin/docker-compose" | sha256sum -c \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/coding-conventions.md b/docs/coding-conventions.md index 3d7b4fbfc13..fe1f067d5d1 100644 --- a/docs/coding-conventions.md +++ b/docs/coding-conventions.md @@ -1,15 +1,15 @@ -# oSPARC Coding Conventions +# Coding Conventions and Linters -This document is meant to serve as a guide to writing code in the osparc-simcore platform. +Coding styles and linters are provided for the Javascript and Python. ## Javascript -### Naming +In general the `qooxdoo` naming convention/style is followed. The [Access](http://qooxdoo.org/docs/#/core/oo_feature_summary?id=access) paragraph is the most notable. It is recommended to read the entire document. -Private members as well as private methods will include double underscore as prefix and will be written in camelcase +Have a look at `ESLint`'s configuration files [.eslintrc.json](.eslintrc.json) and [.eslintignore](.eslintignore). -```js -__myPrivateVariable: null, -__myPrivateMethod: function() {} +## Python -``` +`Black` will enforce the style. Just use it. + +Have a look at `Pylint`'s configuration file [.pylintrc](.pylintrc). diff --git a/docs/no-upstream-push.md b/docs/no-upstream-push.md new file mode 100644 index 00000000000..f02fab93502 --- /dev/null +++ b/docs/no-upstream-push.md @@ -0,0 +1,29 @@ +# How to avoid pushing to upstream + +To avoid accidents, consider removing push permissions on your upstream from +your local repository. + + + \path-to\osparc-simcore (master -> origin) + $ git status + On branch master + Your branch is up-to-date with 'origin/master'. + nothing to commit, working directory clean + + \path-to\osparc-simcore (master -> origin) + $ git remote -vv + origin git@github.com:ITISFoundation/osparc-simcore.git (fetch) + origin git@github.com:ITISFoundation/osparc-simcore.git (push) + + \path-to\osparc-simcore (master -> origin) + $ git remote add upstream git@github.com:GITUSER/osparc-simcore.git + + \path-to\osparc-simcore (master -> origin) + $ git remote set-url upstream --push "You shall not push but use PR instead" + + \path-to\osparc-simcore (master -> origin) + $ git remote -vv + origin git@github.com:ITISFoundation/osparc-simcore.git (fetch) + origin git@github.com:ITISFoundation/osparc-simcore.git (push) + upstream git@github.com:GITUSER/osparc-simcore.git (fetch) + upstream You shall not push but use PR instead (push) diff --git a/docs/python-dependencies.md b/docs/python-dependencies.md index 106e2f95b69..fa212d5c411 100644 --- a/docs/python-dependencies.md +++ b/docs/python-dependencies.md @@ -85,7 +85,7 @@ Every python package specifies its dependencies to the installer via the ``setup ### Updates [March 2020] -1. Created common makefile in (scripts/requirements.Makefile)[scripts/requirements.Makefile] +1. Created common makefile in [scripts/requirements.Makefile](scripts/requirements.Makefile) ## Workflows