Add README-maintainers.md

CHANGELOG.md

@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - New facts `cisco_node_utils` and `cisco_nxapi` report the installed version of these gems.
 - Providers requiring the `cisco_node_utils` feature will generate a warning message if an obsolete gem version is installed.
+- Added README-maintainers.md
 
 ### Fixed
 - Metadata URLs now point to new public GitHub repository.

docs/README-maintainers.md

@@ -0,0 +1,80 @@
+# Maintainers Guide
+
+Guidelines for the core maintainers of the ciscopuppet project - above and beyond the [general developer guidelines](https://github.com/cisco/cisco-network-puppet-module/blob/develop/CONTRIBUTING.md).
+
+## Accepting Pull Requests
+
+* Is the pull request correctly submitted against the `develop` branch?
+* (TODO - not yet) Does `rubocop` pass? (TODO - this will be part of our CI integration to run automatically)
+* Is `CHANGELOG.md` updated appropriately?
+* Are new Beaker tests added? Do they provide sufficient coverage and consistent results?
+* Are the example manifests updated appropriately? Does puppet-lint pass? (TODO - add to CI)
+* Do tests pass on both N9K and N3K? (In particular, N3048 often has unique behavior.)
+
+## Setting up git-flow
+
+If you don't already have [`git-flow`](https://github.com/petervanderdoes/gitflow/) installed, install it.
+
+Either run `git flow init` from the repository root directory, or manually edit your `.git/config` file. Either way, when done, you should have the following in your config:
+
+```ini
+[gitflow "branch"]
+        master = master
+        develop = develop
+[gitflow "prefix"]
+        feature = feature/
+        release = release/
+        hotfix = hotfix/
+        support = support/
+        versiontag = v
+```
+
+Most of these are default for git-flow except for the `versiontag` setting.
+
+## Release Process
+
+When we agree as a team that a new release should be published, the process is as follows:
+
+1. Ensure that tests have been executed against released Gem versions (release a new version if necessary!) and do not have dependencies on unreleased Gem code.
+
+2. Create a release branch. Follow [semantic versioning](http://semver.org) - a bugfix release is a 0.0.x version bump, a new feature is a 0.x.0 bump, and a backward-incompatible change is a new x.0.0 version. 
+
+    ```
+    git flow release start 1.0.1
+    ```
+
+3. In the newly created release branch, update `CHANGELOG.md`:
+
+    ```diff
+    -## [Unreleased]
+    +## [1.0.1] - 2015-08-28
+    ...
+    +[1.0.1]: https://github.com/cisco/cisco-network-puppet-module/compare/v1.0.0...v1.0.1
+    [1.0.0]: https://github.com/cisco/cisco-network-puppet-module/compare/v0.9.0...v1.0.0
+    ```
+    
+    and also update `metadata.json`:
+    
+    ```diff
+       "name": "puppetlabs-ciscopuppet",
+    -  "version": "1.0.0",
+    +  "version": "1.0.1",
+       "author": "cisco",
+    ```
+    
+4. Commit your changes and push the release branch to GitHub for review by Cisco and PuppetLabs:
+
+	```
+	git flow release publish 1.0.1
+	```
+	
+5. Once Cisco and PuppetLabs are in agreement that the release branch is sane, finish the release and push the finished release to GitHub:
+
+    ```
+    git flow release finish 1.0.1
+    git push origin master
+    git push origin develop
+    git push --tags
+    ```
+
+6. Add release notes on GitHub, for example `https://github.com/cisco/cisco-network-puppet-module/releases/new?tag=v1.0.1`. Usually this will just be a copy-and-paste of the relevant section of the `CHANGELOG.md`.