@@ -53,11 +53,12 @@ overall information on repository workflow and standards. Note, we use `make
53
53
tools` for installing the linting tools.
54
54
55
55
Other notes:
56
- - Looking for a good place to start contributing? How about checking out some
57
- [ good first issues] ( https://github.com/cosmwasm/wasmd/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 )
58
- - Please make sure to use ` gofmt ` before every commit - the easiest way to do
59
- this is have your editor run it for you upon saving a file. Additionally
60
- please ensure that your code is lint compliant by running ` make lint `
56
+
57
+ - Looking for a good place to start contributing? How about checking out some
58
+ [ good first issues] ( https://github.com/cosmwasm/wasmd/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 )
59
+ - Please make sure to use ` gofmt ` before every commit - the easiest way to do
60
+ this is have your editor run it for you upon saving a file. Additionally
61
+ please ensure that your code is lint compliant by running ` make lint `
61
62
62
63
## Pull Requests
63
64
@@ -84,7 +85,7 @@ All PRs require two Reviews before merge (except docs changes, or variable name-
84
85
85
86
If you open a PR in Gaia, it is mandatory to update the relevant documentation in /docs.
86
87
87
- * If your changes relate specifically to the gaia application, please modify the docs/ folder.
88
+ - If your changes relate specifically to the gaia application, please modify the docs/ folder.
88
89
89
90
## Forking
90
91
@@ -96,19 +97,19 @@ Instead, we use `git remote` to add the fork as a new remote for the original re
96
97
97
98
For instance, to create a fork and work on a branch of it, I would:
98
99
99
- - Create the fork on github, using the fork button.
100
- - Go to the original repo checked out locally (i.e. ` $GOPATH/src/github.com/cosmwasm/wasmd ` )
101
- - ` git remote rename origin upstream `
102
- - ` git remote add origin [email protected] :rigeyrigerige/gaia.git `
100
+ - Create the fork on github, using the fork button.
101
+ - Go to the original repo checked out locally (i.e. ` $GOPATH/src/github.com/cosmwasm/wasmd ` )
102
+ - ` git remote rename origin upstream `
103
+ - ` git remote add origin [email protected] :rigeyrigerige/gaia.git `
103
104
104
105
Now ` origin ` refers to my fork and ` upstream ` refers to the Gaia version.
105
106
So I can ` git push -u origin master ` to update my fork, and make pull requests to Gaia from there.
106
107
Of course, replace ` rigeyrigerige ` with your git handle.
107
108
108
109
To pull in updates from the origin repo, run
109
110
110
- - ` git fetch upstream `
111
- - ` git rebase upstream/master ` (or whatever branch you want)
111
+ - ` git fetch upstream `
112
+ - ` git rebase upstream/master ` (or whatever branch you want)
112
113
113
114
Please don't make Pull Requests to ` master ` .
114
115
@@ -152,13 +153,13 @@ for tcIndex, tc := range cases {
152
153
<some code>
153
154
for i := 0 ; i < tc.numTxsToTest ; i++ {
154
155
<some code>
155
- require.Equal (t, expectedTx[:32 ], calculatedTx[:32 ],
156
- " First 32 bytes of the txs differed. tc #%d , i #%d " , tcIndex, i)
156
+ require.Equal (t, expectedTx[:32 ], calculatedTx[:32 ],
157
+ " First 32 bytes of the txs differed. tc #%d , i #%d " , tcIndex, i)
157
158
` ` `
158
159
159
160
## Branching Model and Release
160
161
161
- User-facing repos should adhere to the trunk based development branching model: https://trunkbaseddevelopment.com/.
162
+ User-facing repos should adhere to the [ trunk based development branching model]( https://trunkbaseddevelopment.com/) .
162
163
163
164
Libraries need not follow the model strictly, but would be wise to.
164
165
@@ -173,17 +174,19 @@ should be targeted against the release candidate branch. Release candidate branc
173
174
only pull requests targeted directly against master.
174
175
175
176
### Development Procedure
176
- - the latest state of development is on ` master`
177
- - ` master` must never fail ` make test` or ` make test_cli`
178
- - ` master` should not fail ` make lint`
179
- - no ` --force` onto ` master` (except when reverting a broken commit, which should seldom happen)
180
- - create a development branch either on github.com/cosmwasm/wasmd, or your fork (using ` git remote add origin` )
181
- - before submitting a pull request, begin ` git rebase` on top of ` master`
177
+
178
+ - the latest state of development is on ` master`
179
+ - ` master` must never fail ` make test` or ` make test_cli`
180
+ - ` master` should not fail ` make lint`
181
+ - no ` --force` onto ` master` (except when reverting a broken commit, which should seldom happen)
182
+ - create a development branch either on github.com/cosmwasm/wasmd, or your fork (using ` git remote add origin` )
183
+ - before submitting a pull request, begin ` git rebase` on top of ` master`
182
184
183
185
### Pull Merge Procedure
184
- - ensure pull branch is rebased on ` master`
185
- - run ` make test` and ` make test_cli` to ensure that all tests pass
186
- - merge pull request
186
+
187
+ - ensure pull branch is rebased on ` master`
188
+ - run ` make test` and ` make test_cli` to ensure that all tests pass
189
+ - merge pull request
187
190
188
191
### Release Procedure
189
192
@@ -206,15 +209,15 @@ only pull requests targeted directly against master.
206
209
At the moment, only a single major release will be supported, so all point
207
210
releases will be based off of that release.
208
211
209
- - start on ` vX.XX .X `
210
- - checkout a new branch ` pre-rc/vX.X .X `
211
- - cherry pick the desired changes from ` master`
212
- - these changes should be small and NON-BREAKING (both API and state machine)
213
- - add entries to CHANGELOG.md and remove corresponding pending log entries
214
- - checkout a new branch ` rc/vX.X .X ` based off of ` vX.XX .X `
215
- - create a PR merging ` pre-rc/vX.X .X ` into ` rc/vX.X .X `
216
- - run tests and simulations (noted in [Release Procedure](#release-procedure))
217
- - after tests and simulation have successfully completed, create the release branch ` release/vX.XX .X ` from the ` RC` branch
218
- - delete the ` pre-rc/vX.X .X ` and ` RC` branches
219
- - create a PR into ` master` containing ONLY the CHANGELOG.md updates
220
- - tag and release ` release/vX.XX .X `
212
+ - start on ` vX.XX .X `
213
+ - checkout a new branch ` pre-rc/vX.X .X `
214
+ - cherry pick the desired changes from ` master`
215
+ - these changes should be small and NON-BREAKING (both API and state machine)
216
+ - add entries to CHANGELOG.md and remove corresponding pending log entries
217
+ - checkout a new branch ` rc/vX.X .X ` based off of ` vX.XX .X `
218
+ - create a PR merging ` pre-rc/vX.X .X ` into ` rc/vX.X .X `
219
+ - run tests and simulations (noted in [Release Procedure](#release-procedure))
220
+ - after tests and simulation have successfully completed, create the release branch ` release/vX.XX .X ` from the ` RC` branch
221
+ - delete the ` pre-rc/vX.X .X ` and ` RC` branches
222
+ - create a PR into ` master` containing ONLY the CHANGELOG.md updates
223
+ - tag and release ` release/vX.XX .X `
0 commit comments