Merge PR Finschia#101: v1.0.0 Changelog Updates

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,7 +9,7 @@ v    If a checkbox is n/a - please still include it but + a little note why
 - [ ] Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
 - [ ] Wrote tests
 - [ ] Updated relevant documentation (`docs/`)
-- [ ] Added a relevant changelog entry: `clog add [section] [stanza] [message]`
+- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
 - [ ] Reviewed `Files changed` in the github PR explorer
 
 ______

CHANGELOG.md

@@ -1,6 +1,30 @@
+<!--
+Guiding Principles:
+
+Changelogs are for humans, not machines.
+There should be an entry for every single version.
+The same types of changes should be grouped.
+Versions and sections should be linkable.
+The latest version comes first.
+The release date of each version is displayed.
+Mention whether you follow Semantic Versioning.
+
+Types of changes (Stanzas):
+
+"Features" for new features.
+"Improvements" for changes in existing functionality.
+"Deprecated" for soon-to-be removed features.
+"Bug Fixes" for any bug fixes.
+"Breaking" for breaking API changes.
+
+Ref: https://keepachangelog.com/en/1.0.0/
+-->
+
 # Changelog
 
-## 1.0.0
+## [Unreleased]
+
+## [1.0.0] - 2019-08-13
 
 ### Bug Fixes
 
@@ -54,3 +78,8 @@
 * (rest) [\#4123](https://github.com/cosmos/cosmos-sdk/issues/4123) Fix typo, url error and outdated command description of doc clients.
 * (rest) [\#4129](https://github.com/cosmos/cosmos-sdk/issues/4129) Translate doc clients to chinese.
 * (rest) [\#4141](https://github.com/cosmos/cosmos-sdk/issues/4141) Fix /txs/encode endpoint
+
+<!-- Release links -->
+
+[Unreleased]: https://github.com/cosmos/gaia/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/cosmos/gaia/releases/tag/v1.0.0

CONTRIBUTING.md

@@ -1,17 +1,18 @@
 # Contributing
 
-* [Pull Requests](#pull-requests)
-  * [Process for reviewing PRs](#process-for-reviewing-prs)
-  * [Updating Documentation](#updating-documentation)
-* [Forking](#forking)
-* [Dependencies](#dependencies)
-* [Testing](#testing)
-* [Branching Model and Release](#branching-model-and-release)
-  * [PR Targeting](#pr-targeting)
-  * [Development Procedure](#development-procedure)
-  * [Pull Merge Procedure](#pull-merge-procedure)
-  * [Release Procedure](#release-procedure)
-  * [Point Release Procedure](#point-release-procedure)
+- [Contributing](#contributing)
+  - [Pull Requests](#pull-requests)
+    - [Process for reviewing PRs](#process-for-reviewing-prs)
+    - [Updating Documentation](#updating-documentation)
+  - [Forking](#forking)
+  - [Dependencies](#dependencies)
+  - [Testing](#testing)
+  - [Branching Model and Release](#branching-model-and-release)
+    - [PR Targeting](#pr-targeting)
+    - [Development Procedure](#development-procedure)
+    - [Pull Merge Procedure](#pull-merge-procedure)
+    - [Release Procedure](#release-procedure)
+    - [Point Release Procedure](#point-release-procedure)
 
 Thank you for considering making contributions to Gaia and related
 repositories!
@@ -182,14 +183,21 @@ only pull requests targeted directly against master.
   - merge pull request
 
 ### Release Procedure
-  - start on `master`
-  - create the release candidate branch `rc/v*` (going forward known as **RC**) and ensure it's protected against pushing from anyone except the release manager/coordinator. **no PRs targeting this branch should be merged unless exceptional circumstances arise**
-  - on the `RC` branch, use `clog` to prepare the `CHANGELOG.md` and kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks).
-  - if errors are found during the simulation testing, commit the fixes to `master` and create a new `RC` branch (making sure to increment the `rcN`)
-  - after simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch
-  - merge the release branch to `master` to incorporate the `CHANGELOG.md` updates
-  - delete the `RC` branches
- 
+
+- Start on `master`
+- Create the release candidate branch `rc/v*` (going forward known as **RC**)
+  and ensure it's protected against pushing from anyone except the release
+  manager/coordinator
+  - **no PRs targeting this branch should be merged unless exceptional circumstances arise**
+- On the `RC` branch, prepare a new version section in the `CHANGELOG.md` and
+  kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks)
+- If errors are found during the simulation testing, commit the fixes to `master`
+  and create a new `RC` branch (making sure to increment the `rcN`)
+- After simulation has successfully completed, create the release branch
+  (`release/vX.XX.X`) from the `RC` branch
+- Merge the release branch to `master` to incorporate the `CHANGELOG.md` updates
+- Delete the `RC` branches
+
 ### Point Release Procedure
 
 At the moment, only a single major release will be supported, so all point

contrib/devtools/Makefile

@@ -46,7 +46,6 @@ TOOLS_DESTDIR  ?= $(GOPATH)/bin
 
 GOLANGCI_LINT   = $(TOOLS_DESTDIR)/golangci-lint
 GOIMPORTS       = $(TOOLS_DESTDIR)/goimports
-CLOG            = $(TOOLS_DESTDIR)/clog
 RUNSIM          = $(TOOLS_DESTDIR)/runsim
 
 all: tools
@@ -61,16 +60,13 @@ $(GOLANGCI_LINT): $(mkfile_dir)/install-golangci-lint.sh
 $(GOIMPORTS):
 	go get golang.org/x/tools/cmd/goimports@v0.0.0-20190628034336-212fb13d595e
 
-$(CLOG):
-	go get github.com/cosmos/tools/cmd/clog/
-
 $(RUNSIM):
 	go get github.com/cosmos/tools/cmd/runsim/
 
 golangci-lint: $(GOLANGCI_LINT)
 
 tools-clean:
-	rm -f $(GOIMPORTS) $(CLOG) $(GOLANGCI_LINT)
+	rm -f $(GOIMPORTS) $(GOLANGCI_LINT)
 	rm -f tools-stamp
 
 .PHONY: all tools tools-clean