Skip to content
This repository has been archived by the owner on May 30, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Documentation and components needed to open source
  • Loading branch information
danielfx90 committed Sep 19, 2018
1 parent 8d3d43e commit a426039
Show file tree
Hide file tree
Showing 5 changed files with 151 additions and 9 deletions.
73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,73 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at developers@wibson.org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[Contributor Covenant]: https://www.contributor-covenant.org
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,50 @@
# Contributing to Wibson

_In open source, we feel strongly that to really do something well, you have to get a lot of people involved._—Linus Torvalds

We really appreciate and value contributions to Wibson. Please review the items listed below to make sure that your contributions are merged as soon as possible.

## Reporting Security Vulnerabilities
If you think that you have found a security issue in Wibson, please **DO NOT** use post it as a Github issue and don't publish it publicly. Instead, all security issues must be sent to developers@wibson.org.
Although we are working on setting up a bug bounty program to improve this, we appreciate your discretion and will give the corresponding credit to the reporter(s).

## Common Contribution Process
In the spirit of openness, this project follows [the Gitflow model]. We use Pull Requests to develop conversations around ideas, and turn ideas into actions.

**Some PR Basics**
- Anyone can submit a Pull Request with changes they'd like to see made.
- Pull Requests should attempt to solve a single [1], clearly defined problem [2].
- Everyone should submit Pull Requests early (within the first few commits), so everyone on the team is aware of the direction you're taking.
- Authors are responsible for explicitly tagging anyone who might be impacted by the pull request and get the recipient's sign-off [3].
- The Pull Request should serve as the authority on the status of a change, so everyone on the team is aware of the plan of action.
- Relevant domain authority _must_ sign-off on a pull request before it is merged [4].
- Anyone _except_ the author can merge a pull request once all sign-offs are complete and all status checks have passed.
- Pull Requests must be submitted against the `develop` branch.

[1]: if there are multiple problems you're solving, it is recommended that you create a branch for each. For example, if you are implementing a small change and realize you want to refactor an entire function, you might want to implement the refactor as your first branch (and pull request), then create a new branch (and pull request) from the refactor to implement your new _feature_. This helps resolve merge conflicts and separates out the logical components of the decision-making process.
[2]: include a description of the problem that is being resolved in the description field, or a reference to the issue number where the problem is reported. Examples include; "Follow Button doesn't Reflect State of Follow" or "Copy on Front-page is Converting Poorly".
[3]: notably, document the outcome of any out-of-band conversations in the pull request.
[4]: changes to marketing copy, for example, must be approved by the authority on marketing.

## Coding Style
We follow the rules described in the [.soliumrc.json] file for the smart contracts code and `airbnb-base` as described in [.eslintrc.js] file for tests and any other JS code.

Please, make sure running `npm run lint:all` finishes successfully.

## Code of Conduct
To ensure an inclusive community, contributors and users in the Wibson community should follow the code of conduct.

## License
By contributing, you agree that your contributions will be licensed under the [LGPL-3.0] License.

## All set!
If you have any questions, feel free to post them to github.com/wibsonorg/wibson-core/issues.

Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/wibsonorg/wibson-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

Thanks for your time and code. Happy coding!

[the Gitflow model]: http://nvie.com/posts/a-successful-git-branching-model/
[.soliumrc.json]: .soliumrc.json
[.eslintrc.js]: .eslintrc.js
[LGPL-3.0]: LICENSE
29 changes: 20 additions & 9 deletions README.md
@@ -1,9 +1,10 @@
# Wibson
# <img src="logo.png" alt="Wibson" width="400px">

[Wibson](https://wibson.org/) is a blockchain-based, decentralized data marketplace that provides individuals a way to securely and anonymously sell validated private information in a trusted environment.

**wibson-core** is the implementation of the underlying protocol of Wibson using the Ethereum platform.

> NOTE: For more details about the protocol please read our white paper [here](https://wibson.org/).
> NOTE: For more details about the protocol, please read our white paper [here](https://wibson.org/).
## Getting Started
In order to run tests or deploy to local or any remote environment, the `deploy.json` file must be set up.
Expand Down Expand Up @@ -55,12 +56,14 @@ $ npm run truffle console --network staging # to test within the console
#### Release Data:
#### Deployed Addresses:

- WIBToken: `0x`
- DataExchange: `0x`
- Migrations `0x`
- MultiMap `0x`
- ECRecovery `0x`
- CryptoUtils `0x`
- WIBToken: `0x3f17dd476faf0a4855572f0b6ed5115d9bba22ad`
- DataExchange: `0xd077c09a7e65c4cca490a776d5e395fb4fe7179a`
- MultiMap `0x72ae13d70f65c56e59eb63993605abef1ecb9c41`
- CryptoUtils `0x48819464877341cb7e0bbd91e0c268016ae5e6ad`
- Math `0x9c2693a1e04eb127b0d628e276a98fef235ee9e2`
- SafeMath `0x6919a6710bfa555e70cc8cd35bf2e613c355c443`
- ECRecovery `0x59740db1350bcac14fd3a3451d47205a1d499499`
- Migrations `0xde2e43f4831cd95a41b3bdc8947209f86670e446`

## Protocol's Gas Consumption

Expand All @@ -80,6 +83,14 @@ $ npm run truffle console --network staging # to test within the console

\*\*\* Calculated with a dataHash of 58 bytes.

## Reporting Security Vulnerabilities
If you think that you have found a security issue in Wibson, please **DO NOT** use post it as a Github issue and don't publish it publicly. Instead, all security issues must be sent to developers@wibson.org.
Although we are working on setting up a bug bounty program to improve this, we appreciate your discretion and will give the corresponding credit to the reporter(s).

## Contribute
Thank you for thinking about contributing to Wibson Core. There are many ways you can participate and help build high quality software. Check out the [contribution guide]!

## License
Wibson Core is released under the [LGPL-3.0](LICENSE).

LGPL-3.0
[contribution guide]: CONTRIBUTING.md
Binary file added logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions package.json
Expand Up @@ -3,6 +3,14 @@
"version": "1.0.0",
"author": "Wibson Development Team <developers@wibson.org>",
"license": "LGPL-3.0",
"engines": {
"node": "~8.11.3",
"npm": ">= 6.1.0"
},
"repository": {
"type": "git",
"url": "https://github.com/wibsonorg/wibson-core.git"
},
"scripts": {
"compile": "truffle compile",
"lint:sol": "solium -d .",
Expand Down

0 comments on commit a426039

Please sign in to comment.