Skip to content

Commit 7715a76

Browse files
committed
Updating Contribute section to be specific.
1 parent 2325313 commit 7715a76

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,33 @@ rake gem:build
161161
vagrant plugin install pkg/vagrant-hostmanager-*.gem
162162
```
163163

164+
164165
Contribute
165166
----------
166-
Contributions are welcome.
167+
To contribute, fork then clone the repository, and then the following:
168+
169+
**Developing**
170+
171+
1. Install [Bundler](http://bundler.io/)
172+
2. Currently the Bundler version is locked to 1.6.9, please install this version.
173+
* `sudo gem install bundler -v '1.6.9'`
174+
3. Then install vagrant-hostmanager dependancies:
175+
* `bundle _1.6.9_ install`
176+
177+
**Releasing**
178+
179+
To release a new version of vagrant-hostmanager you will need to do the following:
180+
181+
*(only contributors of the GitHub repo and owners of the project at RubyGems will have rights to do this)*
167182

168-
1. Fork it
169-
2. Create your feature branch (`git checkout -b my-new-feature`)
170-
3. Commit your changes (`git commit -am 'Add some feature'`)
171-
4. Push to the branch (`git push origin my-new-feature`)
172-
5. Create new Pull Request
183+
1. First, bump the version in ~/lib/vagrant-hostmanager/version.rb:
184+
* Follow [Semantic Versioning](http://semver.org/).
185+
2. Then, create a matching GitHub Release (this will also create a tag):
186+
* Preface the version number with a `v`.
187+
* https://github.com/smdahlen/vagrant-hostmanager/releases
188+
3. You will then need to build and push the new gem to RubyGems:
189+
* `rake gem:build`
190+
* `gem push pkg/vagrant-hostmanager-1.6.1.gem`
191+
4. Then, when John Doe runs the following, they will receive the updated vagrant-hostmanager plugin:
192+
* `vagrant plugin update`
193+
* `vagrant plugin update vagrant-hostmanager`

0 commit comments

Comments
 (0)