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 readme #153

Merged
merged 4 commits into from
Jan 15, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<!---

TO INSURE THE FASTEST RESPONSE POSSIBLE, PLEASE READ THESE INSTRUCTIONS
CAREFULLY.

-->

<!--- Please provide a short summary of the issue in the Title above -->

<!--- When you see empty square brackets below, that's a checkbox. Replace the space with
[x] to check the box -->


## Expected Behavior

<!---

If you're describing a bug, tell us what should happen.

If you're suggesting a change/improvement, tell us how it should work.

-->

## Current Behavior

<!---

If describing a bug, tell us what happens instead of the expected behavior.

If suggesting a change/improvement, explain the difference from current
behavior.

-->

## Possible Solution

<!---

Not obligatory, but this is the place to suggest the underlying cause and
possible fix for the bug, if you have one, or ideas how to implement the
addition or change.

-->

## Steps to Reproduce (for bugs)

<!---

This is the most important information you can give us in this bug report.
Without good information here, it will take much longer to get your issue
resolved!

If possible, please provide a link to a live example, or an unambiguous set of
steps to reproduce this bug. Include code to reproduce, if relevant.

-->
1.
2.
3.
4.

## Context
<!---

How has this issue affected you? What are you trying to accomplish? Is this
issue likely to block you or others from getting your work done?

-->

## Your Environment
* Version:
* OS: [ ] OSX, [ ] Linux, [ ] Windows
* OS Version:
* Version of Truffle/Remix/Other tools used:
* NodeJS Version:
* Commit hash:
* I intend to submit a pull request to fix this issue: [ ]

<!--- When you're finished with the above, you may need to delete these comments to avoid
whitespace formatting issues -->

<!--- Modified from: https://github.com/trufflesuite/ganache-cli/blob/v7.0.0-beta.0/ISSUE_TEMPLATE.md -->
18 changes: 18 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
* **Please check if the PR fulfills these requirements**
- [ ] Unit tests for the changes have been added
- [ ] Docs have been added / updated (for bug fixes / features)


* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)



* **If this is a feature change, what is the new behavior ?**



* **Does this PR introduce a breaking change?** (how will this change the workflow of developers or users?)



* **Other information**:
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -105,7 +105,7 @@ Steps for regenerating are as follows:

2. Run the following command to regenerate the contract bindings:

./build/bin/abigen --sol shyft-cli/web3/validSignersDeploy/ValidSigners.sol --pkg shyft_contracts --out generated_bindings/whisper_signer_binding.go
./build/bin/abigen --sol ./shyft-config/shyft-cli/web3/validSignersDeploy/ValidSigners.sol --pkg shyft_contracts --out generated_bindings/whisper_signer_binding.go

```

@@ -172,7 +172,7 @@ ie. for shyftBlockExplorerApi:

The Postgresql Database Container will persist the database data to the directory ``./pg-data`` _. So if you do want to reinitialize the database you should delete this directory as well as the blockchain data directories ``(./shyftData ./privatenet)`` prior to launching the docker containers. There is a shell script available to delete these folders to run it execute the following command:

**``./shyft-cli/resetShyftGeth``**
**``./shyft-config/shyft-cli/resetShyftGeth``**

Blockchain data is persisted to **``./ethash/.ethash and ./shyftData__``**. If you would like to reset the test blockchain you will need to delete the **``__./ethash ./shyftData & ./privatenet__``** directories.

@@ -533,7 +533,7 @@ limit blocks converge to (`--targetgaslimit`) and the price transactions are acc

#### CLI

Run `./shyft-geth` with one of the following flags:
Run `./shyft-config/shyft-geth` with one of the following flags:

- `--setup` - Setups postgres and the shyft chain db.
- `--start` - Starts geth.
@@ -603,26 +603,18 @@ _TODO_

## Contribution

Thank you for considering to help out with the source code! We welcome contributions from
anyone on the internet, and are grateful for even the smallest of fixes!
If you'd like to contribute to go-empyrean, please fork, fix, commit and send a pull request against the `development` branch.

We have a list of issues available on github.

If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request
for the maintainers to review and merge into the main code base. If you wish to submit more
complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ShyftNetwork/go-empyrean)
to ensure those changes are in line with the general philosophy of the project and/or get some
early feedback which can make both your efforts much lighter as well as our review and merge
procedures quick and simple.
For general communication, we communicate on [our gitter channel](https://gitter.im/ShyftNetwork/go-empyrean).

Please make sure your contributions adhere to our coding guidelines:

- Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
- Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
- Pull requests need to be based on and opened against the `master` branch.
- Commit messages should be prefixed with the package(s) they modify.
- E.g. "eth, rpc: make trace configs optional"
- Pull requests need to be based on and opened against the `development` branch.

Please see the [Developers' Guide](https://github.com/empyrean/go-ethereum/wiki/Developers'-Guide)
for more details on configuring your environment, managing project dependencies and testing procedures.

## License