This repository was archived by the owner on Jul 19, 2025. It is now read-only.
Prep repo to release 1.0.0.rc1 to rubygems #34
Merged
Conversation
This file contains hidden or 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
maxjacobson
force-pushed
the
mj-prep-for-gem-release
branch
from
df9a553 to
cb59deb
Compare
|
@codeclimate/review finished fleshing out the documentation in the README. Ready for a look 👀 |
ABaldwinHunter
approved these changes
Sep 28, 2016
|
|
||
| [@nporteschaikin]: https://github.com/nporteschaikin | ||
| [@pbrisbin]: https://github.com/pbrisbin | ||
| [@wfleming]: https://github.com/wfleming |
There was a problem hiding this comment.
should bryan be here?
There was a problem hiding this comment.
I was thinking about fleshing out the bottom of the changelog and I can mention Bryan there. This section of the changelog can grow as needed, as people's names are referenced above (this is a weird markdown syntax where you make a hyperlink at the top and look up the address at the bottom by name, and we don't currently mention Bryan, so he doesn't show up)
| when an individual is representing the project or its community. | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting a project maintainer at max@hardscrabble.net. All |
There was a problem hiding this comment.
heh wait good catch I copied this from another project but I'd like to change this to hello@codeclimate.com
* Document release process
* update license year
* pull version from version.rb, set to 1.0.0.rc1
* Add changelog, document changelog process (modeled after rubocop's
process)
* Add a Code of Conduct
* Move development dependencies to Gemfile
* I think it's a better practice. The only practical consequence I know of
is that they don't show up in the dependencies list on rubygems.org,
otherwise it's basically the same.
* Change to ruby 2.3.1 for development version
* 1.9.3 continues to exist in the travis test matrix. We could set a
minimum ruby version that we want to support, but we're actually using
1.9.3 ourselves so I think it's good that we're testing there.
* Specify virtus dependency optimistically
* Motivated by this warning:
```
$ gem build minidoc.gemspec
WARNING: pessimistic dependency on virtus (~> 1.0.0) may be overly strict
if virtus is semantically versioned, use:
add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.0'
WARNING: See http://guides.rubygems.org/specification-reference/ for help
```
* Add Code Climate as an author (Following pattern from codeclimate/codeclimate)
* Flesh out the documentation in the README
maxjacobson
force-pushed
the
mj-prep-for-gem-release
branch
from
cb59deb to
b5a151c
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
process)
is that they don't show up in the dependencies list on rubygems.org,
otherwise it's basically the same.
minimum ruby version that we want to support, but we're actually using
1.9.3 ourselves so I think it's good that we're testing there.
Motivated by this warning:
I'd like to merge this, and then do a bit of spit-and-polish on the README (feel free to help) and, I think, improve the first-run experience so users can get a better error if they try to use Minidoc before setting a connection or database_name, and then release this as v1.0.0.rc1, update our services, and if everything goes well, release it as v1.0.0.
WDYT?