Skip to content

Commit

Permalink
maintenance housekeeping: README, CONTRIBUTORS
Browse files Browse the repository at this point in the history
  • Loading branch information
arcolife committed Jul 10, 2018
1 parent 89f525d commit 238aef5
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 24 deletions.
Empty file added CHANGELOG.md
Empty file.
10 changes: 0 additions & 10 deletions CONTRIBUTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@ At the moment, here's the workflow we follow for sending a feature request.
5. Close/Refer to the issue specific to the PR. For example, for issue #14, add `fixes #14` to the first line of commit message
6. Add a `signed off by` message in your commits. Helps distribute incentives to the community. We'll redesign this part in near future.


## Code of Conduct

Refer to `CODE_OF_CONDUCT.md`

Join our gitter channel for live discussions and clarifications.

1. For contributions/general engineering discussions and all things PR/codebases [truechain-net/engg-foss-global](https://gitter.im/truechain-net/engg-foss-global)
2. For events, announcements and so on [truechain-net/community](https://gitter.im/truechain-net/community)
3. For research, [truechain-net/research](https://gitter.im/truechain-net/research)
4. Architecture at [truechain-net/architecture](https://gitter.im/truechain-net/architecture)

Subscribe to the [google groups mailing list](https://groups.google.com/forum/#!forum/truechain) to receive regular updates and post discussions
File renamed without changes.
4 changes: 4 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
General maintainers:~ Archit Sharma (@arcolife)

- dep
- `hmake` command: Chen Xi (@hixichen)
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# truechain-consensus-core
TrueChain Consensus Protocol

## Guide

For pbft specific installation, checkout `pbft/` folder

## Feedback

Feedback is greatly appreciated. We're a blend of `py-go-c++` devs looking to merge ideas and we may err at times in the realm of language paradigms and correct design approach. We're hoping to find you (yes you!) and incentivize you for auditing our codebase, polish the erm out of it and teach us how to fish in this process. Feel free to open issues / contact us on our channels.

## Contributing

We need contributions from you. You are welcome to create github issues and contribute to the codebase.
We have a list of important tasks from Truechain Foundation. We welcome people who have related background to join
our consensus design and implementation.

The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
The project follows the typical GitHub pull request model.
See [CONTRIBUTIONS.md](CONTRIBUTIONS.md) for more details.
Before starting any work, please either comment on an existing issue, or file a new one.

## Community / Mailing lists

Join our gitter channel for live discussions and clarifications.

1. For contributions/general engineering discussions and all things PR/codebases [truechain-net/engg-foss-global](https://gitter.im/truechain-net/engg-foss-global)
2. For events, announcements and so on [truechain-net/community](https://gitter.im/truechain-net/community)
3. For research, [truechain-net/research](https://gitter.im/truechain-net/research)
4. Architecture at [truechain-net/architecture](https://gitter.im/truechain-net/architecture)

Subscribe to the [google groups mailing list](https://groups.google.com/forum/#!forum/truechain) to receive regular updates and post discussions


## LICENSE

The Apache License (2.0).

A copy of the header is included within all files in the codebase along with the full [LICENSE](LICENSE) txt file in project's root folder.
14 changes: 0 additions & 14 deletions pbft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ This code base is an ongoing implementation of Practical Byzantine Fault Toleran

Although there exists a bunch of existing PBFT implementations, we decide to write our own version to get fully control of every details and to conveniently make necessary extensions so that it could fit into the hybrid consensus protocol (which requires more than a standard PBFT).



### Installation

#### Step 1
Expand Down Expand Up @@ -114,15 +112,3 @@ To be added.
### Benchmark

To be added.

### How to contribute

We need contributions from you. You are welcome to create github issues and contribute to the codebase. Developer Guide could be found in `docs/DEV.md`.
We have a list of important tasks from Foundation. We welcome people who have related background to join our consensus design and implementation.


### LICENSE

The Apache License (2.0).

A copy of the header is included within all files in the codebase along with the full LICENSE txt file in project's root folder.

0 comments on commit 238aef5

Please sign in to comment.