Skip to content
This repository has been archived by the owner on Mar 23, 2021. It is now read-only.

Separate examples per concerns #326

Closed
D4nte opened this issue Jan 10, 2020 · 2 comments
Closed

Separate examples per concerns #326

D4nte opened this issue Jan 10, 2020 · 2 comments

Comments

@D4nte
Copy link
Contributor

D4nte commented Jan 10, 2020

Problem

The current examples are fulfilling 2 concerns:

  1. Show how to code a COMIT App (e.g. code comments in separate_apps)
  2. Demonstrate and explained how an atomic swap is run (e.g. use of readLineSync to make the run interactive)

Several times we have evolved examples for 2. to the detriment of 1.

Moreover, with the new accountability structure, 1. Falls under product (devex) and 2. under community.

Goal

Remove any possible conflict/friction/obstacle for the various streams to be done.

Recommendation

  1. Create a new demo folder beside the existing example folder
  2. Duplicate the separate_apps (and improve naming) to the demo folder, strip the code from the comments.
  3. In examples/separate_apps, remove the interactiveness
  4. Decide if something similar needs to be done for btc_eth and erc20_btc.

Priority Justification

This is a pre-requisite to any future evolution of the examples (e.g. from workshop feedback).

In examples/separate_apps, remove the interactiveness

Should be done with the "get ready" documentation so this example becomes the target COMIT App that we build in the get ready doc.

@da-kami
Copy link
Member

da-kami commented Jan 23, 2020

@D4nte isnt's this already done and merged?

@D4nte
Copy link
Contributor Author

D4nte commented Jan 27, 2020

Done with #383

@D4nte D4nte closed this as completed Jan 27, 2020
@D4nte D4nte added this to the Sprint 26 🏉🎇 milestone Jan 27, 2020
@D4nte D4nte self-assigned this Jan 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants