-
Notifications
You must be signed in to change notification settings - Fork 68
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
Showing
57 changed files
with
3,594 additions
and
647 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
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,36 @@ | ||
# How to Contribute | ||
Cisco Network Elements support a rich set of features to make networks robust, efficient and secure. This project enables Cisco Network Elements to be managed by Puppet by defining a set of resource types and providers. This set is expected to grow with contributions from Cisco, Puppet Labs and third-party alike. Contributions to this project are welcome. To ensure code quality, contributers will be requested to follow a few guidelines. | ||
|
||
## Getting Started | ||
|
||
* Create a [GitHub account](https://github.com/signup/free) | ||
* Make sure you have a [cisco.com](http://cisco.com) account, if you need access to a Network Simulator to test your code. | ||
|
||
## Making Changes | ||
|
||
* Fork the repository | ||
* Pull a branch under the "develop" branch for your changes. | ||
* Follow all guidelines documented in [README-creating-types-providers](#README-creating-types-providers.md) | ||
* Make changes in your branch. | ||
* Testing | ||
* TBD: Add beaker test cases to validate your changes. | ||
* Run all the tests to ensure there was no collateral damage to existing code. | ||
* Check for unnecessary whitespace with `git diff --check` | ||
* Run `rubocop --lint` against all changed files. See [https://rubygems.org/gems/rubocop](https://rubygems.org/gems/rubocop) | ||
* TBD: Run [puppet-lint](https://rubygems.org/gems/puppet-lint) against changed files. | ||
* For new resources, add a 'demo' entry to examples/demo_install.rb | ||
* Ensure that your commit messages clearly describe the problem you are trying to solve and the proposed solution. | ||
|
||
## Submitting Changes | ||
|
||
* All contributions you submit to this project are voluntary and subject to the terms of the Apache 2.0 license. | ||
* Submit a pull request for commit approval to the "develop" branch. | ||
* A core team consisting of Cisco and Puppet Labs employees will looks at Pull Request and provide feedback. | ||
* After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity. | ||
|
||
# Additional Resources | ||
|
||
* [General GitHub documentation](http://help.github.com/) | ||
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) | ||
* \#puppet-dev IRC channel on freenode.org ([Archive](https://botbot.me/freenode/puppet-dev/)) | ||
* [puppet-dev mailing list](https://groups.google.com/forum/#!forum/puppet-dev) |
Oops, something went wrong.