Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README with verbose Contributing section #16

Merged
merged 14 commits into from
Jul 3, 2014
Merged

Update README with verbose Contributing section #16

merged 14 commits into from
Jul 3, 2014

Conversation

limhoff-r7
Copy link
Contributor

MSP-10039

Update the Contributing section of the README to be very verbose about how to change PRERELEASE, MINOR, PATCH, and what the expected format of PRs should be with templates.

@limhoff-r7
Verbose contributing steps
4322f5e 
MSP-10039
@limhoff-r7
Fix formatting
92c434c 
MSP-10039
@limhoff-r7
Update name to SUMMARY in Versioning
0a28fa9 
MSP-10039

The branch SUMMARY, not the entire name is used for PRERELEASE.
@limhoff-r7
Copy link
Contributor Author

Verification Steps

  • bundle install

rake spec

  • rake spec
  • VERIFY no failures

README.md

  • Read README.md
  • VERIFY no spelling, grammatical, formatting, or informational errors.

CONTRIBUTING.md

  • Read CONTRIBUTING.md
  • VERIFY no spelling, grammatical, formatting, or informational errors.

@limhoff-r7
Copy link
Contributor Author

Post-merge Steps

Perform these steps prior to pushing to master or the build will be broke on master.

Version

  • Edit lib/metasploit/model/version.rb
  • Remove PRERELEASE and its comment as PRERELEASE is not defined on master.

Gem build

  • gem build *.gemspec
  • VERIFY the gem has no '.pre' version suffix.

RSpec

  • rake spec
  • VERIFY version examples pass without failures

Commit & Push

  • git commit -a
  • git push origin master

@limhoff-r7
Copy link
Contributor Author

Release

Complete these steps on master

JRuby

  • rvm use jruby@metasploit-model
  • rm Gemfile.lock
  • bundle install
  • rake release

MRI Ruby

  • rvm use ruby-1.9.3@metasploit-model
  • rm Gemfile.lock
  • bundle install
  • rake release

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.29%) when pulling 0a28fa9 on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.65%) when pulling 03c19e4 on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.77%) when pulling beed508 on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.7%) when pulling 26c6c91 on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.35%) when pulling 779eb1f on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.76%) when pulling 779eb1f on feature/MSP-10039/readme into 26a2618 on master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.41%) when pulling df9a71b on feature/MSP-10039/readme into 26a2618 on master.

@limhoff-r7
Moving README's Contributing section to its own file
66b40ad 
MSP-10039
@limhoff-r7
Move version bump to Release steps
675b4aa 
MSP-10039

This way it is the responsibility of a trusted contributor to change the
version instead of the pull requester.
@limhoff-r7
Fix Typo
6b686d9 
MSP-10039
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.64%) when pulling 6b686d9 on feature/MSP-10039/readme into 26a2618 on master.

trosen-r7 added a commit that referenced this pull request Jul 3, 2014
@trosen-r7
Merge pull request #16 from rapid7/feature/MSP-10039/readme
615889d 
Update README with verbose Contributing section
@trosen-r7 trosen-r7 merged commit 615889d into master Jul 3, 2014
@trosen-r7 trosen-r7 deleted the feature/MSP-10039/readme branch July 3, 2014 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@limhoff-r7 @coveralls @trosen-r7