Skip to content

Commit c783e36

Browse files
authored
Update contributing doc (#1)
* Add steps for updating VRT version * Only display build status badge for master builds * Add more detailed release plan
1 parent 7262e2c commit c783e36

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,17 @@ Bugcrowd welcomes community feedback and direct contributions to the Bugcrowd VR
55
Please open your feedback as an **Issue** and label it as either a `bug` or an `enhancement`. Large or systemic changes should first be discussed in an Issue rather than be submitted as a pull request directly.
66

77
Prior to opening a pull request please ensure your suggested changes pass specs. The repository uses [`rspec`](https://github.com/rspec/rspec) for spec running, run it with `bundle install && bundle exec rspec`.
8+
9+
### Updating the VRT version
10+
When a new version of the VRT is released, we follow these steps:
11+
1. Add new submodule of the new version tag
12+
- `git submodule add [email protected]:bugcrowd/vulnerability-rating-taxonomy.git lib/data/X.X`
13+
- `cd lib/data/X.X`
14+
- `git checkout vX.X`
15+
2. Cut new version of the gem
16+
- update Vrt::VERSION
17+
- `rake build`
18+
3. Push new version to rubygems
19+
- `gem push OUTPUT_OF_RAKE_BUILD`
20+
4. Update dependent applications
21+
- `bundle update vrt`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</p>
44
<p align="center">
55
<img src="https://badge.fury.io/rb/vrt.svg" />
6-
<img src="https://badge.buildkite.com/96e360e0465da5f781829145aad202ebbdf3f8e7d296501c87.svg" />
6+
<img src="https://badge.buildkite.com/96e360e0465da5f781829145aad202ebbdf3f8e7d296501c87.svg?branch=master" />
77
</p>
88

99
# VRT Ruby Wrapper

0 commit comments

Comments
 (0)