From 20c1daa2abadc87134f174ab1e2cbd6eb9feb99a Mon Sep 17 00:00:00 2001 From: Felipe Faraggi Date: Fri, 7 Feb 2020 18:06:46 +0100 Subject: [PATCH] roll back on ALL-CAPS.md files for TSC proposal Signed-off-by: Felipe Faraggi --- CODEOWNERS.md | 0 CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 4 +-- ISSUE_TEMPLATE.md | 0 NOTICE.md | 0 PULL_REQUEST_TEMPLATE.md | 39 +++++++++++++++++++++ ROADMAP.md | 66 +++++++++++++++++++++++++++++++++++ SECURITY.md | 11 ++++++ SUPPORT.md | 24 +++++++++++++ 9 files changed, 216 insertions(+), 2 deletions(-) create mode 100644 CODEOWNERS.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 ISSUE_TEMPLATE.md create mode 100644 NOTICE.md create mode 100644 PULL_REQUEST_TEMPLATE.md create mode 100644 ROADMAP.md create mode 100644 SECURITY.md create mode 100644 SUPPORT.md diff --git a/CODEOWNERS.md b/CODEOWNERS.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..dfd1c60cceb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# 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 [private@pegasys.tech]. 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 +[private@pegasys.tech]: mailto:private@pegasys.tech \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e0428356bf..9529e4f7a1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,9 @@ Welcome to the Besu repository! The following links are a set of guidelines for ### LF / Jira Accounts Having the following accounts is necessary for contributing code/issues to Besu. -* If you want to contribute code, you can make a [Linux Foundation (LF) account] here. +* If you want to contribute code, you can make a [github account here](https://github.com). * If you want to raise an issue, you can login to your [Atlassian account here](https://id.atlassian.com/). -* Our Rocket Chat also requires a [Linux Foundation (LF) account]. +* Our Rocket Chat requires a [Linux Foundation (LF) account]. ### Useful contributing links diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..edfac2bb41a --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +## Status +**READY/IN DEVELOPMENT/HOLD** + +## Description +A few sentences describing the overall goals of the pull request's commits. + +## Related PRs +List related PRs against other branches: + +branch | PR +------ | ------ +other_pr_production | [link]() +other_pr_master | [link]() + + +## Todos +- [ ] Tests +- [ ] Documentation + + +## Deploy Notes +Notes regarding deployment the contained body of work. These should note any +db migrations, etc. + +## Steps to Test or Reproduce +Outline the steps to test or reproduce the PR here. + +```sh +git pull --prune +git checkout +bundle; script/server +``` + +1. + +## Impacted Areas in Application +List general components of the application that this PR will affect: + +* \ No newline at end of file diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 00000000000..7adb9304157 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,66 @@ +# Roadmap +This document represents the current working roadmap for Besu. It is a living document, which will +evolve and change over time. In particular the features in later versions are likely to be refined and change. + +We use the approach of `#now`, `#next`, `#later` [used by foursquare](https://medium.com/@noah_weiss/now-next-later-roadmaps-without-the-drudgery-1cfe65656645), with a slightly different time horizon. +Our `#now` scale is about 3 months, `#next` about 6 months, and `+later` is 12+ months. + +## Now (up to v1.3) +Our key areas for now are: +* Making Besu a First Class Client +* Istanbul Support +* State Pruning +* Disaster recovery + +### Making Besu a First Class Client + +First and foremost, we want Besu to be a first class client for usage on both mainnet and permissioned networks. +This entails maintaining compatibility with mainnet, providing permissioning features and constantly improving Besu's performance. +Some recent additions to the client have been [UPnP Support](https://docs.besu.pegasys.tech/en/latest/Configuring-Besu/Networking/Using-UPnP/) +and a [GraphQL interface](https://docs.besu.pegasys.tech/en/latest/Besu-API/GraphQL/). + +### Istanbul Support + +Besu will support the upcoming Istanbul network upgrade and implement all required EIPs as per the [Hardfork Meta: Istanbul EIP](https://eips.ethereum.org/EIPS/eip-1679). + +### State Pruning + +State pruning will be implemented. State pruning reduces the disk space required for the Besu database by discarding outdated world state data. + +### Disaster Recovery + +Support key-value storage in relational databases to solidify a robust Disaster Recovery process. Note: Orion to support Oracle and Postgres in 1.3. + +## Next (v1.4) +The key areas for next are: +* Tracing APIs +* Enhancing key management capabilities +* Migration tools +* Ethereum 1.x + +### Tracing APIs + +Additional tracing APIs to be added. + +### Enhancing Key Management + +Enhancing key management capabilities by supporting secure storage of keys. + +### Migration Tools + +Adding tools to enable migration across consensus algorithms. + +### Ethereum 1.x + +The Besu team will help spearhead the Ethereum 1.x initiative by contributing to EIPs, community discussions, roadmap specificaton and eventually implementing the resulting features from the initiative. More information on the 1.x initiative can be found [here](https://docs.ethhub.io/ethereum-roadmap/ethereum-1.x/). + +## Future (v1.5+) +In addition to making incremental improvements to the above features, there will be some bigger pieces of work. +These are deliberately kept vague at this time, and will be elaborated upon when they move up to the now and next levels of work. + +* Ethereum 2.0 +* Alternate Consensus Mechanisms +* Sidechains +* Privacy group consensus +* Cross privacy group communication +* On-chain privacy \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000000..73255812096 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,11 @@ +# Hyperledger Security Policy + +## Reporting a Security Bug + +If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to hear from you. We will take all security bugs seriously and if confirmed upon investigation we will patch it within a reasonable amount of time and release a public security bulletin discussing the impact and credit the discoverer. + +There are two ways to report a security bug. The easiest is to email a description of the flaw and any related information (e.g. reproduction steps, version) to [security at hyperledger dot org](mailto:security@hyperledger.org). + +The other way is to file a confidential security bug in our [JIRA bug tracking system](https://jira.hyperledger.org). Be sure to set the “Security Level” to “Security issue”. + +The process by which the Hyperledger Security Team handles security bugs is documented further in our [Defect Response page](https://wiki.hyperledger.org/display/HYP/Defect+Response) on our [wiki](https://wiki.hyperledger.org). diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000000..a28b0076e7c --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,24 @@ +# Hyperledger Besu Support + +Welcome to the Besu repository! The following links are a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. Contributions come in the form of code submissions, writing documentation, raising issues, helping others in chat, and any other actions that help develop Besu. + +### LF / Jira Accounts + +Having the following accounts is necessary for obtaining support for Besu. +* If you want to raise an issue, you can login to your [Atlassian account here](https://id.atlassian.com/). +* Our Rocket Chat requires a [Linux Foundation (LF) account]. +* The Hyperlegder wiki also requires a [Linux Foundation (LF) account] in order to edit pages. + +### Useful support links + +* [Besu User Documentation] +* [RocketChat] +* [I just have a quick question](https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question) +* [Did you find a bug?](https://wiki.hyperledger.org/display/BESU/Reporting+Bugs) +* [Issues](https://wiki.hyperledger.org/display/BESU/Issues) +* [Contributing Guidelines] + + +[Besu User Documentation]: https://besu.hyperledger.org +[RocketChat]: https://chat.hyperledger.org/ +[Contributing Guidelines]: CONTRIBUTING.md \ No newline at end of file