Skip to content

Commit

Permalink
fixes #752
Browse files Browse the repository at this point in the history
  • Loading branch information
dejanpan committed Jul 31, 2017
1 parent 4f10211 commit abee0a3
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Autoware is protected by the BSD License. Please use it on at your own discretio

Free manuals can be found at [https://github.com/CPFL/Autoware-Manuals](https://github.com/CPFL/Autoware-Manuals). You are encouraged to join maintenance of those manuals. Thanks for your cooperation!

See also Autoware/docs for the tips of Autoware development, including the coding style and branching model.
See also [branching_model](https://github.com/CPFL/Autoware/blob/master/docs/en/branching_model.md) for the tips of Autoware development, including the coding style and branching model.

## License

Expand Down
22 changes: 16 additions & 6 deletions docs/en/branching_model.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,32 @@
# Branching model for Autoware development
# Development Model in Autoware
## Development Workflow
To assure traceablity in our code we follow this development process:
* If you are working on a feature/bug/new-release => create an issue first
* create a branch, work on the feature/bug/new-release, refer in at least one commit to the issue #number
* open pull request for given feature/bug/new-release and fill out pull request template.

This will assure that we know where the feature originated from and the implementation will be linked to the feature request (or bug report). Otherwise there is absolutely no traceability.
Secondly, with the pull request template it will be easier for the reviewer(s) to understand the changes and we can later on convert "Steps to Reproduce" into integration tests.

## Branching model for Autoware development

In order to keep efficient open-source development of Autoware, we ask all developers to comply with the branching model described below.
On this model, we maily use five branches - master, develop, release, feature, and hotfix.
On this model, we maily use five branches - master, develop, release, feature, and bugfix.

## Development
### Development
In general, developers should work on the "develop" branch.
When you develop new functions, please check out a new branch, "feature/[branch_name]", from the "develop" branch, and modify the code there.
After the modificaiton, please send a pull request to the "develop" branch.

## Release
### Release
This situation is true of only the persons in charge of releasing Autoware.
Once we complete some major development, we make a new release.
For the release work, please checkout a new branch, "release/[1.xx.yy], from the "develop" branch, and modify the code there.
After the modification, please send a pull request: "xx" in version of release/[1.xx.yy] is increased when checked out from the "develop" branch, and yy is also increased when bug fixes are done.
Finally, we merge this branch to the master branch, attaching a version tag.

## Bugfix
If we encounter bugs in the "master" branch after the release, we check out the "hotfix" branch from the "master" branch and fix the bugs.
### Bugfix
If we encounter bugs in the "master" branch after the release, we check out the "bugfix" branch from the "master" branch and fix the bugs.
This branch is merged to each corresponding branch - master, release, and develop.
After the merge, the version of the master and the release branches is increased.

Expand Down
23 changes: 23 additions & 0 deletions docs/issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Fill-out only one section depending on whether you are reporting a bug or a new feature.

# Bug
## Expected Behavior


## Actual Behavior


## Steps to Reproduce the Problem

1.
1.
1.

## Specifications

- Ubuntu version:
- ROS Version:
- Autoware branch:

# New Feature
Describe where does new feature request come from. Add high-level picture of how the new feature should work.
27 changes: 27 additions & 0 deletions docs/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Status
**PRODUCTION / DEVELOPMENT**

## Description
A few sentences describing the overall goals of the pull request's commits.

## Related PRs
List related PRs against other branches:

branch | PR
------ | ------
other_pr_production | [link]()
other_pr_master | [link]()


## Todos
- [ ] Tests
- [ ] Documentation


## Steps to Test or Reproduce
Outline the steps to test or reproduce the PR here.

```
roslaunch pkg_A executable_A
```
The car should move.

0 comments on commit abee0a3

Please sign in to comment.