Add Contributing Guidelines #1422

rigelrozanski · 2018-06-28T00:11:07Z

Adapted from Tendermint figured we want this with all the external contributors coming around

Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)
Updated CHANGELOG.md

N/A:

Updated all relevant documentation in docs
Updated all code comments where relevant
Wrote tests
Updated Gaia/Examples

ValarDragon · 2018-06-28T00:15:49Z

CONTRIBUTING.md

+
+Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/cosmos/cosmos-sdk/issues) for things we need help with!
+
+Please make sure to use `gofmt` before every commit - the easiest way to do this is have your editor run it for you upon saving a file.


Can we add make test_lint here too?

changelog int

cwgoes · 2018-06-28T00:37:28Z

CONTRIBUTING.md

+
+Thank you for considering making contributions to Cosmos-SDK and related repositories! Start by taking a look at this [coding repo](https://github.com/tendermint/coding) for overall information on repository workflow and standards.
+
+Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/cosmos/cosmos-sdk/issues) for things we need help with!


Can we link to issues tagged with "help-wanted" (and do a better job at tagging issues "help-wanted")?

cwgoes · 2018-06-28T00:38:23Z

CONTRIBUTING.md

+
+We use [dep](https://github.com/golang/dep) to manage dependencies.
+
+That said, the master branch of every Cosmos repository should just build


If we promise this can we test it automatically somehow?

Doesn't circle ci have to run make install in order to run the cli tests, so this already would be checked as long as master is passing tests. (Which it always should)

sure we can not sure we need to though?

cwgoes · 2018-06-28T00:38:59Z

CONTRIBUTING.md

+- the latest state of development is on `develop`
+- `develop` must never fail `make test`
+- no --force onto `develop` (except when reverting a broken commit, which should seldom happen)
+- create a development branch either on github.com/cosmos/cosmos-sdk, or your fork (using `git add origin`)


git remote add origin?

yeah I think so - addressed

cwgoes · 2018-06-28T00:39:26Z

CONTRIBUTING.md

+
+### Pull Merge Procedure:
+- ensure pull branch is rebased on develop
+- run `make test` to ensure that all tests pass


make test test_cli, at least at the moment, they can also just run make

thanks added

cwgoes · 2018-06-28T00:40:03Z

CONTRIBUTING.md

+- ensure pull branch is rebased on develop
+- run `make test` to ensure that all tests pass
+- merge pull request
+- the `unstable` branch may be used to aggregate pull merges before testing once


Interesting; do we have an unstable branch?

we used too - I'm deleting for now

cwgoes · 2018-06-28T00:41:40Z

CONTRIBUTING.md

+
+### Release Procedure:
+- start on `develop`
+- run integration tests (see `test_integrations` in Makefile)


We definitely do not have a test_integrations command

codecov · 2018-06-29T03:29:32Z

Codecov Report

Merging #1422 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           develop   #1422   +/-   ##
=======================================
  Coverage       63%     63%           
=======================================
  Files          118     118           
  Lines         6573    6573           
=======================================
  Hits          4141    4141           
  Misses        2161    2161           
  Partials       271     271

cwgoes

utACK, looks like CI is failing (strangely) though

cwgoes · 2018-06-29T07:30:19Z

Also let's add make format - ref #1455 (comment)

alexanderbez

Left a few remarks, but otherwise 👍 .

alexanderbez · 2018-06-29T14:09:23Z

CONTRIBUTING.md

+- start on `develop`
+- prepare changelog/release issue
+- bump versions
+- push to release-vX.X.X to run CI


Do we want to elaborate on versioning conventions (especially for hotfixes)?

Added link to https://semver.org

alexanderbez · 2018-06-29T14:09:46Z

CONTRIBUTING.md

+- before submitting a pull request, begin `git rebase` on top of `develop`
+
+### Pull Merge Procedure:
+- ensure pull branch is rebased on develop


develop* 👍

alexanderbez · 2018-06-29T14:11:49Z

CONTRIBUTING.md

+
+Libraries need not follow the model strictly, but would be wise to
+
+### Development Procedure:


It's implicit that the contributed work adheres to our linting standards correct (e.g. formatting, vet, imports, etc...)?

Added a reference to make test_lint.

…dk into rigel/contributing_guide

cwgoes

utACK

* Merge pull request #1422: Add Contributing Guidelines * cwgoes comments

rigelrozanski added T:Docs Changes and features related to documentation. ready-for-review labels Jun 28, 2018

rigelrozanski requested a review from cwgoes June 28, 2018 00:11

rigelrozanski requested a review from ebuchman as a code owner June 28, 2018 00:11

rigelrozanski force-pushed the rigel/contributing_guide branch from 004e678 to e1fbc24 Compare June 28, 2018 00:15

ValarDragon reviewed Jun 28, 2018

View reviewed changes

Merge pull request #1422: Add Contributing Guidelines

696a308

changelog int

rigelrozanski force-pushed the rigel/contributing_guide branch from e1fbc24 to 696a308 Compare June 28, 2018 00:20

cwgoes reviewed Jun 28, 2018

View reviewed changes

Merge branch 'develop' into rigel/contributing_guide

1e91143

cwgoes comments

be67d1c

cwgoes previously approved these changes Jun 29, 2018

View reviewed changes

Merge branch 'develop' into rigel/contributing_guide

0700f88

ValarDragon mentioned this pull request Jun 29, 2018

tools: Add make format #1455

Merged

7 tasks

alexanderbez reviewed Jun 29, 2018

View reviewed changes

rigelrozanski and others added 3 commits June 29, 2018 13:14

Merge branch 'develop' into rigel/contributing_guide

5e5fa5f

Merge branch 'develop' into rigel/contributing_guide

26854cf

Merge branch 'develop' into rigel/contributing_guide

bf6a190

cwgoes dismissed their stale review via c9ee621 June 30, 2018 01:50

Merge branch 'rigel/contributing_guide' of github.com:cosmos/cosmos-s…

c4f9d87

…dk into rigel/contributing_guide

cwgoes force-pushed the rigel/contributing_guide branch from c9ee621 to c4f9d87 Compare June 30, 2018 01:51

cwgoes approved these changes Jun 30, 2018

View reviewed changes

cwgoes merged commit 2f508f5 into develop Jun 30, 2018

cwgoes deleted the rigel/contributing_guide branch June 30, 2018 02:04

adrianbrink pushed a commit that referenced this pull request Jul 2, 2018

Merge PR #1422: Add Contributing Guidelines

63ee3e3

* Merge pull request #1422: Add Contributing Guidelines * cwgoes comments

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Contributing Guidelines #1422

Add Contributing Guidelines #1422

rigelrozanski commented Jun 28, 2018 •

edited

Loading

ValarDragon Jun 28, 2018

rigelrozanski Jun 28, 2018

cwgoes Jun 28, 2018

rigelrozanski Jun 29, 2018

rigelrozanski Jun 29, 2018

cwgoes Jun 28, 2018

ValarDragon Jun 29, 2018 •

edited

Loading

rigelrozanski Jun 29, 2018

cwgoes Jun 28, 2018

rigelrozanski Jun 29, 2018

cwgoes Jun 28, 2018

rigelrozanski Jun 29, 2018

cwgoes Jun 28, 2018

rigelrozanski Jun 29, 2018

cwgoes Jun 28, 2018

rigelrozanski Jun 29, 2018

codecov bot commented Jun 29, 2018 •

edited

Loading

cwgoes left a comment

cwgoes commented Jun 29, 2018

alexanderbez left a comment

alexanderbez Jun 29, 2018

cwgoes Jun 30, 2018 •

edited

Loading

alexanderbez Jun 29, 2018

alexanderbez Jun 29, 2018

cwgoes Jun 30, 2018

cwgoes left a comment


		Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/cosmos/cosmos-sdk/issues) for things we need help with!

		Please make sure to use `gofmt` before every commit - the easiest way to do this is have your editor run it for you upon saving a file.


		Thank you for considering making contributions to Cosmos-SDK and related repositories! Start by taking a look at this [coding repo](https://github.com/tendermint/coding) for overall information on repository workflow and standards.

		Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/cosmos/cosmos-sdk/issues) for things we need help with!


		We use [dep](https://github.com/golang/dep) to manage dependencies.

		That said, the master branch of every Cosmos repository should just build


		Libraries need not follow the model strictly, but would be wise to

		### Development Procedure:

Add Contributing Guidelines #1422

Add Contributing Guidelines #1422

Conversation

rigelrozanski commented Jun 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ValarDragon Jun 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 29, 2018 • edited Loading

Codecov Report

cwgoes left a comment

Choose a reason for hiding this comment

cwgoes commented Jun 29, 2018

alexanderbez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwgoes Jun 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwgoes left a comment

Choose a reason for hiding this comment

rigelrozanski commented Jun 28, 2018 •

edited

Loading

ValarDragon Jun 29, 2018 •

edited

Loading

codecov bot commented Jun 29, 2018 •

edited

Loading

cwgoes Jun 30, 2018 •

edited

Loading