Skip to content

Commit

Permalink
updated dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saden1 committed May 14, 2017
1 parent fe4c9d0 commit 83b48f0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Testify uses a Maven-based build system. To build from source follow the bellow
- [Install GitFlow](http://danielkummer.github.io/git-flow-cheatsheet)
- Initialize GitFlow:
```bash
$ git flow init
git flow init
Branch name for production releases: master
Branch name for "next release" development: develop
Feature branch prefix: feature/
Expand All @@ -25,40 +25,40 @@ Version tag prefix:
### Check out sources
-- Via SSH (preferred for security reasons):
```
$ git clone git@github.com:testify-project/testify.git
git clone git@github.com:testify-project/testify.git
```
- Or via HTTPS:

```
$ git clone https://github.com/testify-project/testify.git
git clone https://github.com/testify-project/testify.git
```

### Compile, build, and install Testify JARs into your local Maven Cache
```
$ mvn install -Dmaven.test.skip
./mvnw install -Dmaven.test.skip
```

### Compile, test, build, and install Testify JARs into your local Maven Cache
```
$ mvn install
./mvnw install
```

## Adding a Feature
- Create a feature:
```bash
$ git flow feature start awesome-feature
git flow feature start awesome-feature
```
- Do some development and commit to awesome-feature branch:
```bash
$ git commit -m "awesome-feature description" .
git commit -m "awesome-feature description" .
```
- Publish feature:
```bash
$ git flow feature publish awesome-feature
git flow feature publish awesome-feature
```
- Finish the feature:
```bash
$ git flow feature finish awesome-feature
git flow feature finish awesome-feature
```

## Issue Pull Request
Expand Down
14 changes: 7 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,30 @@ major.minor.patch
```bash
RELEASE_VERSION=x.x.x
DEVELOPMENT_VERSION=x.x.x-SNAPSHOT
$ git flow release start $RELEASE_VERSION
git flow release start $RELEASE_VERSION
```
- Update the project version in pom files:
```bash
$ mvn versions:set -DnewVersion=$RELEASE_VERSION
./mvnw versions:set -DnewVersion=$RELEASE_VERSION
```
- Update CHANGELOG.md:
- Commit the changes:
```bash
$ git commit -m "Prepare release $RELEASE_VERSION" .
git commit -m "Prepare release $RELEASE_VERSION" .
```
- Finish the release:
```bash
$ git flow release finish $RELEASE_VERSION
git flow release finish $RELEASE_VERSION
```
- Update next development project version in pom files:
```bash
$ mvn versions:set -DnewVersion=$DEVELOPMENT_VERSION
./mvnw versions:set -DnewVersion=$DEVELOPMENT_VERSION
```
- Commit the updated pom files:
```bash
$ git commit -m "Updated next development version to $DEVELOPMENT_VERSION" .
git commit -m "Updated next development version to $DEVELOPMENT_VERSION" .
```
- Push changes, develop, master branches and tags to remote repository:
```bash
$ git push origin develop master --tags
git push origin develop master --tags
```

0 comments on commit 83b48f0

Please sign in to comment.