Skip to content

Commit

Permalink
Technical/Update truemail gemspec
Browse files Browse the repository at this point in the history
* Added development environment guide
* Updated truemail.gemspec
* Updated contributing docs
* Updated gem version, changelog
  • Loading branch information
bestwebua committed Feb 9, 2022
1 parent b694a3c commit fbd6c09
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 20 deletions.
33 changes: 33 additions & 0 deletions .github/DEVELOPMENT_ENVIRONMENT_GUIDE.md
@@ -0,0 +1,33 @@
# Development environment guide

## Preparing

Clone `truemail` repository:

```bash
git clone https://github.com/truemail-rb/truemail.git
cd truemail
```

Configure latest Ruby environment:

```bash
echo 'ruby-3.1.0' > .ruby-version
cp .circleci/gemspec_latest truemail.gemspec
```

## Installing dependencies

```bash
bundle install
bundle exec smtp_mock -s -i ~
```

## Commiting

Commit your changes excluding `.ruby-version`, `truemail.gemspec`

```bash
git add . :!.ruby-version :!truemail.gemspec
git commit -m 'Your new awesome truemail feature'
```
11 changes: 11 additions & 0 deletions CHANGELOG.md
Expand Up @@ -2,6 +2,17 @@

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.6.6] - 2022.02.09

### Added

- Added development environment guide docs

### Updated

- Updated truemail gemspec
- Updated gem version

## [2.6.5] - 2022.02.09

### Added
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -42,5 +42,7 @@ Guidelines for pull requests:
2. Fork the repo, checkout to `develop` branch
3. Run the tests. This is to make sure your starting point works
4. Read our [branch naming convention](.github/BRANCH_NAMING_CONVENTION.md)
5. Create a new branch and make your changes. This includes tests for features!
6. Push to your fork and submit a pull request to `develop` branch
5. Create a new branch
6. Read our [setup development environment guide](.github/DEVELOPMENT_ENVIRONMENT_GUIDE.md)
7. Make your changes. Please note that your PR should include tests for the new codebase!
9. Push to your fork and submit a pull request to `develop` branch
2 changes: 1 addition & 1 deletion lib/truemail/version.rb
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Truemail
VERSION = '2.6.5'
VERSION = '2.6.6'
end
2 changes: 1 addition & 1 deletion spec/support/config/pry.rb
@@ -1,3 +1,3 @@
# frozen_string_literal: true

require 'pry'
require 'pry' if ::RUBY_VERSION[/\A3\.1.+\z/]
24 changes: 8 additions & 16 deletions truemail.gemspec
Expand Up @@ -34,20 +34,12 @@ Gem::Specification.new do |spec|
spec.add_runtime_dependency 'net-smtp', '~> 0.3.1' if ::RUBY_VERSION >= '3.1.0'
spec.add_runtime_dependency 'simpleidn', '~> 0.2.1'

spec.add_development_dependency 'bundler-audit'
spec.add_development_dependency 'dns_mock'
spec.add_development_dependency 'fasterer'
spec.add_development_dependency 'ffaker'
spec.add_development_dependency 'json_matchers'
spec.add_development_dependency 'overcommit'
spec.add_development_dependency 'pry-byebug'
spec.add_development_dependency 'rake'
spec.add_development_dependency 'reek'
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rubocop-performance'
spec.add_development_dependency 'rubocop-rspec'
spec.add_development_dependency 'smtp_mock'
spec.add_development_dependency 'truemail-rspec'
spec.add_development_dependency 'webmock'
spec.add_development_dependency 'dns_mock', '~> 1.5', '>= 1.5.1'
spec.add_development_dependency 'ffaker', '~> 2.20'
spec.add_development_dependency 'json_matchers', '~> 0.11.1'
spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
spec.add_development_dependency 'rspec', '~> 3.10'
spec.add_development_dependency 'smtp_mock', '~> 1.0'
spec.add_development_dependency 'truemail-rspec', '~> 0.7.0'
spec.add_development_dependency 'webmock', '~> 3.14'
end

0 comments on commit fbd6c09

Please sign in to comment.