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

README, INSTALL and CONTRIBUTING files updated #254

Merged
merged 3 commits into from Jun 5, 2018

Conversation

Projects
None yet
5 participants
@zolia
Copy link
Member

commented May 28, 2018

Docs updated. We still have blocker task, which does not allow as to build properly working .deb packages because of root permissions needed. It means documentation is ahead of code still.

Let me know if You want Your descriptions under README.md/Authors changed.

@zolia zolia requested review from donce, tadovas and Waldz as code owners May 28, 2018

@zolia zolia requested review from shroomist, ignasbernotas and interro May 28, 2018

## Authors
* **Valdas Petrulis** - *Lead developer, go evangelist* - [Waldz](https://github.com/Waldz)
* **Tadas Valiukas** - *Senior developer, experienced bug maker* - [tadovas](https://github.com/tadovas)
* **Donatas Kučinskas** - *Senior developer, clean code savvy* - [donce](https://github.com/donce)

This comment has been minimized.

Copy link
@donce

donce May 29, 2018

Contributor

Approve 👍 :D


## Authors
* **Valdas Petrulis** - *Lead developer, go evangelist* - [Waldz](https://github.com/Waldz)
* **Tadas Valiukas** - *Senior developer, experienced bug maker* - [tadovas](https://github.com/tadovas)

This comment has been minimized.

Copy link
@donce

donce May 29, 2018

Contributor

Aprove this as well! :D

@tadovas
Copy link
Member

left a comment

LGTM

@@ -1,8 +1,8 @@
# Contributing guide


Development environment
------------
##Development environment

This comment has been minimized.

Copy link
@donce

donce Jun 5, 2018

Contributor

This formatting does not seem to be working, space after ## is missing:
screen shot 2018-06-05 at 09 55 17

* **Step 2.** Check if all unit tests passes; no vet and linter errors remain.

```bash
bin/test_commit

This comment has been minimized.

Copy link
@donce

donce Jun 5, 2018

Contributor

test_commit runs linter on all touched files. This can result in unrelated errors in touched files - we shouldn't force contributors to fix unrelated linter problems.

- Homepage https://mysterium.network/
## Getting Started

- Homepage https://mysterium.network

This comment has been minimized.

Copy link
@donce

donce Jun 5, 2018

Contributor

Did you make this not as [Homepage](https://mysterium.network), not like others intentionally or accidentally?

This comment has been minimized.

Copy link
@zolia

zolia Jun 5, 2018

Author Member

Its intentional. We need not just a link to our homepage, bet we want it to be memorised.

This comment has been minimized.

Copy link
@ignasbernotas

ignasbernotas Jun 5, 2018

Member

You could do [Homepage https://mysterium.network](https://mysterium.network)

* **Donatas Kučinskas** - *Senior developer, clean code savvy* - [donce](https://github.com/donce)
* **Antanas Masevičius** - *Network engineer / developer, net guru* - [zolia](https://github.com/zolia)
* **Paulius Mozuras** - *Software developer, python lover* - [interro](https://github.com/interro)
* **Ignas Bernotas** - *Full stack developer, lifestyle expert* - [ignasbernotas](https://github.com/ignasbernotas)

This comment has been minimized.

Copy link
@ignasbernotas

ignasbernotas Jun 5, 2018

Member

I would prefer "fun idea generator" or something:D

@donce
Copy link
Contributor

left a comment

Nice docs, now lets prepare for contributions!

@zolia zolia force-pushed the MYST-525-node-operators-documentation branch from 1f1f0c3 to 8157326 Jun 5, 2018

@tadovas
Copy link
Member

left a comment

LGTM

@zolia zolia dismissed stale reviews from tadovas and donce via be47f78 Jun 5, 2018

@zolia zolia force-pushed the MYST-525-node-operators-documentation branch 2 times, most recently from be47f78 to 2c84a0e Jun 5, 2018

zolia added some commits May 28, 2018

@zolia zolia force-pushed the MYST-525-node-operators-documentation branch from 2c84a0e to 2aea1d4 Jun 5, 2018

@tadovas

tadovas approved these changes Jun 5, 2018

@donce

donce approved these changes Jun 5, 2018

@zolia zolia merged commit 7bac074 into master Jun 5, 2018

2 checks passed

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

@zolia zolia deleted the MYST-525-node-operators-documentation branch Jun 5, 2018

@@ -3,18 +3,34 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/MysteriumNetwork/node)](https://goreportcard.com/report/github.com/MysteriumNetwork/node)
[![Build Status](https://travis-ci.org/MysteriumNetwork/node.svg?branch=master)](https://travis-ci.org/MysteriumNetwork/node)

VPN server and client for Mysterium Network
Cross-platform software to run a node in Mysterium Network. It contains Mysterium server (node),
client API (tequila API) and client-cli (console client) for Mysterium Network.

This comment has been minimized.

Copy link
@Waldz

Waldz Jun 5, 2018

Member

tequila API -> tequilAPI

@@ -5,4 +5,4 @@
# Usage example:
#> bin/test_commit

bin/test && bin/vet && bin/lint_git

This comment has been minimized.

Copy link
@Waldz

Waldz Jun 5, 2018

Member

Do You really want to delete lint_git ?

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.