Release documentation (#13)
This commit is contained in:
parent
6e3f1ec43e
commit
5aed624f1d
5 changed files with 36 additions and 20 deletions
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -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
|
||||||
|
```
|
|
@ -1,11 +1,13 @@
|
||||||
# Contributing
|
# 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.
|
1. Check the open [issues](https://github.com/CityOfZion/neo-go/issues) and
|
||||||
2. Open an issue first, to discuss a new feature or enhancement.
|
[pull requests](https://github.com/CityOfZion/neo-go/pulls) for existing discussions.
|
||||||
3. Write tests, and make sure the test suite passes locally and on CI.
|
1. Open an issue first, to discuss a new feature or enhancement.
|
||||||
4. Open a pull request, and reference the relevant issue(s).
|
1. Write tests, and make sure the test suite passes locally and on CI.
|
||||||
5. After receiving feedback, squash your commits and add a great commit message.
|
1. Open a pull request, and reference the relevant issue(s).
|
||||||
6. Have fun!
|
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!**
|
10
README.md
10
README.md
|
@ -12,8 +12,14 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://travis-ci.org/anthdm/neo-go">
|
<a href="https://github.com/CityOfZion/neo-go/releases">
|
||||||
<img src="https://travis-ci.org/anthdm/neo-go.svg?branch=master">
|
<img src="https://img.shields.io/github/tag/CityOfZion/neo-go.svg?style=flat">
|
||||||
|
</a>
|
||||||
|
<a href="https://circleci.com/gh/CityOfZion/neo-go/tree/master">
|
||||||
|
<img src="https://circleci.com/gh/CityOfZion/neo-go/tree/master.svg?style=shield">
|
||||||
|
</a>
|
||||||
|
<a href="https://goreportcard.com/report/github.com/CityOfZion/neo-go">
|
||||||
|
<img src="https://goreportcard.com/badge/github.com/CityOfZion/neo-go">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
2
VERSION
2
VERSION
|
@ -1 +1 @@
|
||||||
0.3.0
|
0.4.0
|
10
circle.yml
10
circle.yml
|
@ -54,24 +54,18 @@ workflows:
|
||||||
filters:
|
filters:
|
||||||
tags:
|
tags:
|
||||||
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
||||||
branches:
|
|
||||||
ignore: master
|
|
||||||
- test:
|
- test:
|
||||||
requires:
|
requires:
|
||||||
- install_deps
|
- install_deps
|
||||||
filters:
|
filters:
|
||||||
tags:
|
tags:
|
||||||
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
||||||
branches:
|
|
||||||
ignore: master
|
|
||||||
- vet:
|
- vet:
|
||||||
requires:
|
requires:
|
||||||
- install_deps
|
- install_deps
|
||||||
filters:
|
filters:
|
||||||
tags:
|
tags:
|
||||||
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
||||||
branches:
|
|
||||||
ignore: master
|
|
||||||
- check_version:
|
- check_version:
|
||||||
filters:
|
filters:
|
||||||
branches:
|
branches:
|
||||||
|
@ -81,6 +75,4 @@ workflows:
|
||||||
- install_deps
|
- install_deps
|
||||||
filters:
|
filters:
|
||||||
tags:
|
tags:
|
||||||
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
only: /[0-9]+\.[0-9]+\.[0-9]+/
|
||||||
branches:
|
|
||||||
ignore: master
|
|
Loading…
Reference in a new issue