docs: refactor contributing guidelines - add development setup #2708
Conversation
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
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
charleenfei,
damiannolan and
chatton
as code owners
9 tasks
colin-axner
approved these changes
Nov 15, 2022
damiannolan
reviewed
Nov 15, 2022
damiannolan
reviewed
Nov 17, 2022
damiannolan
approved these changes
Nov 17, 2022
colin-axner
approved these changes
Nov 21, 2022
|
|
||
| We use [Go 1.14 Modules](https://github.com/golang/go/wiki/Modules) to manage dependency versions. | ||
|
|
||
| The main branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. |
There was a problem hiding this comment.
Suggested change
| The main branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. | |
| The main branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. |
There was a problem hiding this comment.
I'm not sure how useful this section is. I feel like go get is something every go module makes use of?
chatton
reviewed
Jan 16, 2023
Comment on lines
+65
to
+66
| Please make sure to run `make format` before every commit - the easiest way to do this is have your editor run it for you upon saving a file. Additionally please ensure that your code is lint compliant by running `make lint-fix` (requires `golangci-lint`). | ||
|
|
There was a problem hiding this comment.
more of a question, maybe we should set up pre-commit hooks to do this sort of thing instead of requiring additional manual steps. I'm happy with this as is for now!
There was a problem hiding this comment.
Sounds like a good idea! We can investigative this separately. I will leave this for now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
closes: #XXXX
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes