forked from rackerlabs/recap
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41591ab
commit 5f40f9c
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Workflow | ||
|
||
This project uses gitflow, here some documentation about [how gitflow works](https://datasift.github.io/gitflow/IntroducingGitFlow.html) | ||
|
||
# Issues | ||
|
||
Bugs, RFE or others should be documented in the [issues](https://github.com/rackerlabs/recap/issues/). | ||
|
||
## Guidelines | ||
1. Before opening an issue, search [open](https://github.com/rackerlabs/recap/issues?q=is%3Aopen+is%3Aissue) and [closed](https://github.com/rackerlabs/recap/issues?q=is%3Aissue+is%3Aclosed) issues to ensure the issue has not ben reported previously. | ||
1. Ensure the issue can be reproduced with the latest [`development`](https://github.com/rackerlabs/recap/tree/development) version. | ||
1. The issue should contain detailed instructions and when possible logs, as well as the expected result. | ||
1. Include details of the environment where it's running, e.g. Debian Jessie, CentOS 7.3, etc. | ||
1. For RFE explain *Why would this feature be useful?* | ||
|
||
# Pull Requests | ||
|
||
Code contributions are greatly appreciated, please make sure you follow the guidelines below. | ||
|
||
## Pull requests should be | ||
1. Made against the `development` branch. | ||
1. Made from a git feature/fix branch. | ||
1. Associated to a documented issue. | ||
|
||
## Pull requests will not be accepted that | ||
1. Are not made against the `development` branch | ||
1. Are made by editing files via the GitHub website | ||
1. Does not have a documented [issue](https://github.com/rackerlabs/recap/issues/) for it. | ||
|
||
# Coding Guidelines | ||
|
||
There is no enforcement of a code guideline, as there is no standard for it; this styleguide is to some extent being used, hence recommended. [Shell Style Guide](https://google.github.io/styleguide/shell.xml). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters