This repository has been archived by the owner on Nov 6, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions #10652
Merged
Merged
Changes from 8 commits
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
39b5ae9
docs: Update Readme with TOC, Contributor Guide and License sections
ltfschoen 4dd7577
docs: Simplify package descriptions in Readme
ltfschoen 950d634
docs: Fix typos
ltfschoen 11834e3
docs: Update Cargo package configs adding missing descriptions
ltfschoen f91f26d
fix: Remove machine since was accidental from diff branch. Fix contri…
ltfschoen 5892bca
fix: Fix formatting
ltfschoen dfacb82
remove details snippet since not code and formats badly
ltfschoen a37742e
review-fix: Remove duplicate description
ltfschoen 049135e
fix dot point formatting
ltfschoen 10205c9
fix: Add missing description to vm package
ltfschoen cf05a7d
fix: Remove duplicate Code of Conduct and Contributor guidelines
ltfschoen bc30b00
docs: Update Contributing for consistency with other repos
ltfschoen a8132d7
docs: Update Readme to link to existing Code of Conduct and Contribut…
ltfschoen 8124328
refactor: Add missing space
ltfschoen e6e5f82
fix: Fix links to be markdown format
ltfschoen c7f2a87
review-fix: Update CONTRIBUTING.md to link to Parity Ethereum Style G…
ltfschoen 8a139c8
merge latest master and fix conflicts
ltfschoen 282a4e3
Merge branch 'master' into luke-readme2
ltfschoen c40158c
docs: Fix type in .github/CONTRIBUTING.md
ltfschoen d1ec475
docs: Fix typo in .github/CONTRIBUTING.md
ltfschoen e7ac760
docs: Rephrase parity-clib/Cargo.toml
ltfschoen b820960
review-fix: Fix whole paragraph
ltfschoen b9f6384
review-fix: Add comment to prevent direct pushes to master branch
ltfschoen a8fb47d
review-fix: Change some rules to recommendations
ltfschoen cdaa2a7
Update .github/CONTRIBUTING.md
ltfschoen c1163ef
review-fix: Replace feature reduction with breaking changes dot point
ltfschoen 851499d
review-fix: Rephrase what to do when reviewing PR
ltfschoen e9e3920
review-fix: Update parity-rpc package description and module rustdocs
ltfschoen 8d0e013
docs: Add missing fullstop
ltfschoen 95dd2cb
review-fix: Update rustdoc section to show all packages first as default
ltfschoen e87b8ba
review-fix: Rename Parity Util to Parity Core Libraries
ltfschoen 68578b4
review-fix: Rename readme too for the C bindings name change
ltfschoen 39cdd6f
review-fix: Remove some docs since we do not teach the reader Rust
ltfschoen 55d1a3e
review-fix: Wrap Parity Ethereum specific packages in a details section
ltfschoen d880c01
review-fix: Separate tools that are in this repo vs those that are not
ltfschoen 46b5e94
review-fix: Add link to ethabi on crates.io
ltfschoen c1a71f2
review-fix: Remove unnecessary extra line talking about pushing to ma…
ltfschoen 4a85e6c
Merge branch 'master' into luke-readme2
ltfschoen 805e39d
review-fix: Remove useless summary of parts of the rust book document…
ltfschoen c095637
docs: Update .github/CONTRIBUTING.md to specify two reviewers required
ltfschoen 9f69b61
docs: Update README.md with simplification
ltfschoen b89af4f
docs: Update README.md renaming to Test Runner instead of just Run
ltfschoen 68d0f15
review-fix: Remove hardware wallet from docs
ltfschoen 488d9d7
review-fix: Remove veto PR section of contributor doc
ltfschoen 8bfadc0
review-fix: Change to test generator title
ltfschoen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# 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, gender identity and expression, level of experience, 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 | ||
|
||
### Facilitation, Not Strongarming | ||
|
||
We recognize that this software is merely a tool for users to create and maintain their blockchain of preference. We see that blockchains are naturally community platforms with users being the ultimate decision makers. We assert that good software will maximize user agency by facilitate user-expression on the network. As such: | ||
|
||
* This project will strive to give users as much choice as is both reasonable and possible over what protocol they adhere to; but | ||
* use of the project's technical forums, commenting systems, pull requests and issue trackers as a means to express individual protocol preferences is forbidden. | ||
|
||
### 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 admin@parity.io. The project team will review and investigate all complaints, and will respond in a way that it deems 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](http://contributor-covenant.org), version 1.4, available at http://contributor-covenant.org/version/1/4. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Contributing | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this can also go in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, i've removed the duplicate, updated the Readme to refer to the existing file in the .github/ directory, and updated the file |
||
|
||
The `Parity Ethereum` project is an **OPENISH Open Source Project** | ||
|
||
## What? | ||
|
||
Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project. | ||
|
||
## Rules | ||
|
||
There are a few basic ground-rules for contributors (including the maintainer(s) of the project): | ||
|
||
* **No `--force` pushes** or modifying the master branch history in any way. If you need to rebase, ensure you do it in your own repo. | ||
* **Non-master branches**, prefixed with a short name moniker (e.g. `gav-my-feature`) must be used for ongoing work, and include the associated issue ID (if any) in the branch name. | ||
* **All modifications** must be made in a **pull-request** to solicit feedback from other contributors. | ||
* A pull-request *must not be merged until CI* has finished successfully. | ||
* Contributors should adhere to the [house coding style](https://wiki.parity.io/Coding-guide). | ||
|
||
|
||
## Merge Process | ||
|
||
Merging pull requests once CI is successful: | ||
|
||
* A PR needs to be reviewed and approved by project maintainers unless: | ||
* it does not alter any logic (e.g. comments, dependencies, docs), then it may be tagged[`insubstantial`](https://github.com/paritytech/parity-ethereum/pulls?q=is%3Aopen+is%3Apr+label%3A%22A2-insubstantial+%F0%9F%91%B6%22) and merged by its author once CI is complete. | ||
* it is an urgent fix with no large change to logic, then it may be merged after a non-author contributor has approved the review once CI is complete. | ||
|
||
* Once a PR is ready for review please add the [`pleasereview`](https://github.com/paritytech/parity-ethereum/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+label%3A%22A0-pleasereview+%F0%9F%A4%93%22+) label. Generally PRs should sit with this label for 48 hours in order to garner feedback. It may be merged before if all relevant parties had a look at it. | ||
* No PR should be merged until all reviews' comments are addressed. | ||
|
||
*Reviewing pull requests*: | ||
|
||
When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in: | ||
|
||
* Buggy behavior. | ||
* Undue maintenance burden. | ||
* Breaking with house coding style. | ||
* Pessimization (i.e. reduction of speed as measured in the projects benchmarks). | ||
* Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on). | ||
* Uselessness (i.e. it does not strictly add a feature or fix a known issue). | ||
|
||
*Reviews may not be used as an effective veto for a PR because*: | ||
|
||
* There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix. | ||
* It does not fit well with some other contributors' longer-term vision for the project. | ||
|
||
## Helping out | ||
|
||
We use [labels](https://github.com/paritytech/parity-ethereum/labels) to manage PRs and issues and communicate state of a PR. Please familiarize yourself with them. Furthermore we are organizing issues in [milestones](https://github.com/paritytech/parity-ethereum/milestones). Best way to get started is to a pick a ticket from the current milestone tagged [`easy`](https://github.com/paritytech/parity-ethereum/labels/Q2-easy%20%F0%9F%92%83) and get going or [`mentor`](https://github.com/paritytech/parity-ethereum/labels/Q1-mentor%20%F0%9F%95%BA) and get in contact with the mentor offering their support on that larger task. | ||
|
||
## Releases | ||
|
||
Declaring formal releases remains the prerogative of the project maintainer(s). | ||
|
||
## Changes to this arrangement | ||
|
||
This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. | ||
|
||
## Heritage | ||
|
||
These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you move this to
.github/
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, i've removed this and updated the Readme to refer to the existing file that's in the .github/ directory