Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add CONTRIBUTING guidelines and initial changelogs #249

Merged
merged 16 commits into from
Oct 30, 2019
Merged

add CONTRIBUTING guidelines and initial changelogs #249

merged 16 commits into from
Oct 30, 2019

Conversation

ordian
Copy link
Member

@ordian ordian commented Oct 25, 2019 •
edited
Loading

Fixes #248.
Closes #166.

@ordian ordian requested a review from dvdplm October 25, 2019 11:00
dvdplm
dvdplm suggested changes Oct 25, 2019
View reviewed changes
Copy link
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job here, this was long overdue.

CONTRIBUTING.md

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth mentioning the exception of serde that isn't following semver? Caution against rand upgrades?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what to add here. Although serde doesn't follow semver for minor and patch bumping, it will bump major on a breaking change. And not sure how rand is different in terms of breaking changes from other crates. But open to any suggestions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serde: so you're saying we don't need to mention it not following semver because minor/patchreleases are backwards compatible?rand: my thinking was simply that some crate updates are (much) more risky than others, but it's hard to come out and say "don't send PRs to upgrade rand` because it's a mess". But I guess we can handle that as/if PRs come in.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, pretty much

@ordian ordian requested a review from ascjones October 28, 2019 09:28
@ordian ordian requested review from sorpaas and removed request for ascjones October 28, 2019 14:05
ordian added 2 commits October 29, 2019 15:31
@ordian
impl-serde: bump to 0.2.3
3fd73cb
@ordian
Merge branch 'master' into ao-contributing-guidelines
515c75e 
* master:
  impl-serde: bump to 0.2.3
  Fix `impl-serde::serializa/_raw` for empty slices (#253)
  Release impl-rlp 0.2.1 (#250)
@ordian ordian merged commit a9aa589 into master Oct 30, 2019
@ordian ordian deleted the ao-contributing-guidelines branch October 30, 2019 10:18
ordian added a commit that referenced this pull request Nov 10, 2019
@ordian
Merge branch 'master' into ao-rocksdb-switch-to-upstream2
2d42479 
* master:
  add CONTRIBUTING guidelines and initial changelogs (#249)
  impl-serde: bump to 0.2.3 (#254)
  Fix `impl-serde::serializa/_raw` for empty slices (#253)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dvdplm dvdplm dvdplm approved these changes

@sorpaas sorpaas sorpaas approved these changes

Assignees
No one assigned
Labels
A0-pleasereview
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[suggestion] Add contributors guide lines [Suggestion] use rustfmt to maintain code format consistency
3 participants
@ordian @dvdplm @sorpaas