-
Notifications
You must be signed in to change notification settings - Fork 245
add CONTRIBUTING guidelines and initial changelogs #249
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
Changes from 1 commit
a7e3fac
9d58f1d
5e30457
69ff0e6
df9c821
eae6a3b
50ed355
b10ffee
87db8df
e00cbad
a517a01
3fd73cb
515c75e
6a33a17
7f946ce
444ce01
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Contributing to parity-common | ||
|
|
||
| parity-common welcomes contribution from everyone in the form of suggestions, bug | ||
| reports, pull requests, and feedback. This document gives some guidance if you | ||
| are thinking of helping us. | ||
|
|
||
| Please reach out here in a GitHub issue if we can do anything to help you contribute. | ||
|
|
||
| ## Submitting bug reports and feature requests | ||
|
|
||
| When reporting a bug or asking for help, please include enough details so that | ||
| the people helping you can reproduce the behavior you are seeing. For some tips | ||
| on how to approach this, read about how to produce a [Minimal, Complete, and | ||
| Verifiable example]. | ||
|
|
||
| [Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve | ||
|
|
||
| When making a feature request, please make it clear what problem you intend to | ||
| solve with the feature, any ideas for how parity-common could support solving that problem, any possible alternatives, and any disadvantages. | ||
|
|
||
| ## Versioning | ||
|
|
||
| As many crates in the rust ecosystem, all crates in parity-common follow [semantic versioning]. This means bumping PATCH version on bug fixes that don't break backwards compatibility, MINOR version on new features and MAJOR version otherwise (MAJOR.MINOR.PATCH). Versions < 1.0 are considered to have the format 0.MAJOR.MINOR, which means bumping MINOR version for all non-breaking changes. | ||
|
Contributor
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. Worth mentioning the exception of
Contributor
Author
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. Not sure what to add here. Although
Contributor
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.
Contributor
Author
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. yep, pretty much |
||
|
|
||
| If you bump a dependency that publicly exposed in crate's API (e.g. `pub use dependency;` or `pub field: dependency::Dependency`) and the version transition for dependency was semver-breaking, than it is considered to be a breaking change. To put it simply, if you change could cause a compilation error in user's code, it is a breaking change. | ||
|
ordian marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Releasing a new version | ||
|
|
||
| When making a new release make sure to follow these steps: | ||
|
ordian marked this conversation as resolved.
|
||
| * Add a git tag in format `<crate-name>-v<version>`, e.g. `impl-serde-v0.2.2` | ||
| * List all major and breaking changes in the crate's changelog. | ||
| * `cargo publish` | ||
|
ordian marked this conversation as resolved.
Outdated
|
||
|
|
||
| [semantic versioning]: https://semver.org/ | ||
|
|
||
| ## Conduct | ||
|
|
||
| We follow [Substrate Code of Conduct]. | ||
|
|
||
| [Substrate Code of Conduct]: https://github.com/paritytech/substrate/blob/master/CODE_OF_CONDUCT.adoc | ||
|
|
||
| ## Attribution | ||
|
|
||
| This guideline is adapted from [Serde's CONTRIBUTING guide]. | ||
|
|
||
| [Serde's CONTRIBUTING guide]: https://github.com/serde-rs/serde/blob/master/CONTRIBUTING.md | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.8.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
| ### Added | ||
| - uint error type is re-exported (https://github.com/paritytech/parity-common/pull/244) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.5.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.4.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.1.6] - 2019-10-24 | ||
| - Updated to 2018 edition idioms (https://github.com/paritytech/parity-common/pull/237) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.1.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.1.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) | ||
| ### Changed | ||
| - Migrated to 2018 edition (https://github.com/paritytech/parity-common/pull/205) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.1.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) | ||
| ### Added | ||
| - Added no-std support (https://github.com/paritytech/parity-common/pull/154) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.2.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.2.2] - 2019-10-24 | ||
| - Migrated to 2018 edition (https://github.com/paritytech/parity-common/pull/213) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.6.1] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.4.3] - 2019-10-24 | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) | ||
| ### Fixed | ||
| - Fixed nested unbounded lists (https://github.com/paritytech/parity-common/pull/203) | ||
| ### Added | ||
| - Added no-std support (https://github.com/paritytech/parity-common/pull/206) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.1.2] - 2019-10-24 | ||
| - Migrated to 2018 edition (https://github.com/paritytech/parity-common/pull/232) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [2.0.2] - 2019-10-24 | ||
| - Updated to 2018 edition idioms (https://github.com/paritytech/parity-common/pull/237) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.8.1] - 2019-10-24 | ||
| - Migrated to 2018 edition (https://github.com/paritytech/parity-common/pull/214) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Changelog | ||
|
|
||
| The format is based on [Keep a Changelog]. | ||
|
|
||
| [Keep a Changelog]: http://keepachangelog.com/en/1.0.0/ | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [0.8.2] - 2019-10-24 | ||
| ### Fixed | ||
| - Fixed 2018 edition imports (https://github.com/paritytech/parity-common/pull/237) | ||
| - Removed `uninitialized` usage (https://github.com/paritytech/parity-common/pull/238) | ||
| ### Dependencies | ||
| - Updated dependencies (https://github.com/paritytech/parity-common/pull/239) | ||
| ### Changed | ||
| - Modified AsRef impl (https://github.com/paritytech/parity-common/pull/196) |
Uh oh!
There was an error while loading. Please reload this page.