Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING doc #229

Merged
merged 5 commits into from Apr 25, 2018

Conversation

Projects
None yet
3 participants
@zyfdegh
Copy link
Contributor

commented Apr 17, 2018

Add more helpful info for new users in CONTRIBUTING.md to avoid confusion and errors

@zyfdegh zyfdegh requested review from donce, tadovas and Waldz as code owners Apr 17, 2018

@zyfdegh

This comment has been minimized.

Copy link
Contributor Author

commented Apr 17, 2018

Please merge with --squash

on `your.hostname.com:8001`, then the content of the `.env` file should look like this

```
MYSTERIUM_API_URL=http://your.hostname.com:8001/v1

This comment has been minimized.

Copy link
@Waldz

Waldz Apr 17, 2018

Member

No need for external address, could be http://localhost:8001/v1

@@ -28,6 +28,17 @@ cp .env_example .env
vim .env
```

For example if your [api](https://github.com/MysteriumNetwork/api) is listening

This comment has been minimized.

Copy link
@Waldz

Waldz Apr 17, 2018

Member

Idea is to cp .env_example .env and edit file.
Could You add these recommendations to .env_example file

@@ -43,6 +54,41 @@ bin/client_build
bin/client_run
```

Running client in interative cli

This comment has been minimized.

Copy link
@Waldz

Waldz Apr 17, 2018

Member

+100 kudos

@Waldz

Waldz approved these changes Apr 25, 2018

@tadovas
Copy link
Member

left a comment

LGTM

@tadovas tadovas merged commit 17302b9 into mysteriumnetwork:master Apr 25, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

zolia added a commit that referenced this pull request Apr 26, 2018

Update CONTRIBUTING doc (#229)
* update doc: add .env example

* add help docs for client cli

* revert changes on unrelated lines

* add explanation for NATS_SERVER_IP

* modify .env_example instead of massive docs

Waldz added a commit that referenced this pull request Apr 26, 2018

Merge branch 'master' of github.com:MysteriumNetwork/node into featur…
…e/MYST-372-unregister-proposal-skeleton

* 'master' of github.com:MysteriumNetwork/node: (42 commits)
  Add http response header configurable timeout and test
  Update CONTRIBUTING doc (#229)
  retry register proposal
  Refactor connect to return custom error
  Add codeowners file
  Rename CLI startup script
  Unify test script names
  Remove ErrConnectionCancelled error
  Return single cancel error object in Connect
  sprintf instead itoa
  comment added
  fix reconnect issue to gnatsd
  Fix triggered linter errors
  Return 499 when connection creation is cancelled with Cancelable
  Increase timeout to 100 milisecs at least
  Wait for database to become ready before performing migration
  Rename internal function
  Stop tequila after current request is finished, instead of delay
  Refactor to fix some linter errors
  Fix linter errors
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.