From 5aed624f1d6fb12a5a919b75e4c7f945a68b6fc4 Mon Sep 17 00:00:00 2001
From: Charlie Revett
Date: Fri, 2 Feb 2018 19:04:56 +0000
Subject: [PATCH] Release documentation (#13)
---
.github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++
CONTRIBUTING.md | 18 ++++++++++--------
README.md | 10 ++++++++--
VERSION | 2 +-
circle.yml | 10 +---------
5 files changed, 36 insertions(+), 20 deletions(-)
create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..29f30f527
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,16 @@
+### Problem
+
+...
+
+### Solution
+
+...
+
+### Notes
+
+Use [semver](https://semver.org/) to bump `VERSION`, and remember to run the following after
+merging your PR:
+
+```
+make push-tag
+```
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 734da0319..a1cf81c94 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,13 @@
# Contributing
-First, thank you for contributing! We love and encourage pull requests from everyone.
-Before submitting major changes, here are a few guidelines to follow:
+First, thank you for contributing! We love and encourage pull requests from everyone. Please
+follow the guidelines:
-1. Check the open issues and pull requests for existing discussions.
-2. Open an issue first, to discuss a new feature or enhancement.
-3. Write tests, and make sure the test suite passes locally and on CI.
-4. Open a pull request, and reference the relevant issue(s).
-5. After receiving feedback, squash your commits and add a great commit message.
-6. Have fun!
\ No newline at end of file
+1. Check the open [issues](https://github.com/CityOfZion/neo-go/issues) and
+[pull requests](https://github.com/CityOfZion/neo-go/pulls) for existing discussions.
+1. Open an issue first, to discuss a new feature or enhancement.
+1. Write tests, and make sure the test suite passes locally and on CI.
+1. Open a pull request, and reference the relevant issue(s).
+1. After receiving feedback, squash your commits and add a great commit message.
+1. Run `make push-tag` after merging your pull request.
+1. **Have fun!**
\ No newline at end of file
diff --git a/README.md b/README.md
index 0da105a96..b19a5ce7c 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,14 @@
-
-
+
+
+
+
+
+
+
+
diff --git a/VERSION b/VERSION
index 9325c3ccd..60a2d3e96 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.3.0
\ No newline at end of file
+0.4.0
\ No newline at end of file
diff --git a/circle.yml b/circle.yml
index 86ce09569..933007dad 100644
--- a/circle.yml
+++ b/circle.yml
@@ -54,24 +54,18 @@ workflows:
filters:
tags:
only: /[0-9]+\.[0-9]+\.[0-9]+/
- branches:
- ignore: master
- test:
requires:
- install_deps
filters:
tags:
only: /[0-9]+\.[0-9]+\.[0-9]+/
- branches:
- ignore: master
- vet:
requires:
- install_deps
filters:
tags:
only: /[0-9]+\.[0-9]+\.[0-9]+/
- branches:
- ignore: master
- check_version:
filters:
branches:
@@ -81,6 +75,4 @@ workflows:
- install_deps
filters:
tags:
- only: /[0-9]+\.[0-9]+\.[0-9]+/
- branches:
- ignore: master
\ No newline at end of file
+ only: /[0-9]+\.[0-9]+\.[0-9]+/
\ No newline at end of file