From 4da0b1ad7e3a15f6848f94bf05b8c21ae66b67b9 Mon Sep 17 00:00:00 2001 From: dry-bot Date: Sat, 7 Dec 2019 09:54:17 +0000 Subject: [PATCH] [devtools] config sync --- .codeclimate.yml | 12 ++++ .github/ISSUE_TEMPLATE/---bug-report.md | 6 +- .rspec | 2 + .rubocop.yml | 93 +++++++++++++++++++++++-- CODE_OF_CONDUCT.md | 13 ++++ CONTRIBUTING.md | 29 ++++++++ LICENSE | 20 ++++++ 7 files changed, 170 insertions(+), 5 deletions(-) create mode 100644 .codeclimate.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 0000000..5693897 --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,12 @@ +# this file is managed by dry-rb/devtools project + +version: "2" + +exclude_patterns: + - "benchmarks/" + - "examples/" + - "spec/" + +plugins: + rubocop: + enabled: true diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index ed28fef..31c185e 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -9,7 +9,11 @@ assignees: '' **Before you submit this: WE ONLY ACCEPT BUG REPORTS AND FEATURE REQUESTS** -For more information see [our contribution guidelines](https://github.com/dry-rb/dry-cli/blob/master/CONTRIBUTING.md) +For more information see `CONTRIBUTING.md`. + +**Before you report** + +:warning: If you have a problem related to a schema, please **report it under [dry-schema issues](https://github.com/dry-rb/dry-schema/issues/new?assignees=&labels=bug&template=---bug-report.md&title=)** instead. **Describe the bug** diff --git a/.rspec b/.rspec index 83e16f8..e94b608 100644 --- a/.rspec +++ b/.rspec @@ -1,2 +1,4 @@ --color --require spec_helper +--order random + diff --git a/.rubocop.yml b/.rubocop.yml index 9790ad7..4fb902f 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,4 +1,89 @@ -# Please keep AllCops, Bundler, Style, Metrics groups and then order cops -# alphabetically -inherit_from: - - https://raw.githubusercontent.com/hanami/devtools/master/.rubocop.yml +# this file is managed by dry-rb/devtools project + +AllCops: + TargetRubyVersion: 2.4 + +Style/EachWithObject: + Enabled: false + +Style/StringLiterals: + Enabled: true + EnforcedStyle: single_quotes + +Style/Alias: + Enabled: false + +Style/LambdaCall: + Enabled: false + +Style/StabbyLambdaParentheses: + Enabled: false + +Style/FormatString: + Enabled: false + +Style/Documentation: + Enabled: false + +Layout/SpaceInLambdaLiteral: + Enabled: false + +Layout/MultilineMethodCallIndentation: + Enabled: true + EnforcedStyle: indented + +Metrics/LineLength: + Max: 100 + +Metrics/MethodLength: + Max: 22 + +Metrics/ClassLength: + Max: 150 + +Metrics/AbcSize: + Max: 20 + +Metrics/BlockLength: + Enabled: false + +Metrics/CyclomaticComplexity: + Enabled: true + Max: 10 + +Lint/BooleanSymbol: + Enabled: false + +Style/AccessModifierDeclarations: + Enabled: false + +Style/BlockDelimiters: + Enabled: false + +Layout/IndentFirstArrayElement: + EnforcedStyle: consistent + +Style/ClassAndModuleChildren: + Exclude: + - "spec/**/*_spec.rb" + +Lint/HandleExceptions: + Exclude: + - "spec/spec_helper.rb" + +Naming/FileName: + Exclude: + - "lib/dry-*.rb" + +Style/SymbolArray: + Exclude: + - "spec/**/*_spec.rb" + +Style/ConditionalAssignment: + Enabled: false + +Naming/MethodName: + Enabled: false + +Style/AsciiComments: + Enabled: false diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..20feae4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,13 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. + +Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..688a7aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Issue Guidelines + +## Reporting bugs + +If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated. + +## Reporting feature requests + +Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed. + +## Reporting questions, support requests, ideas, concerns etc. + +**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead. + +# Pull Request Guidelines + +A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc. + +Other requirements: + +1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue. +2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style. +3) Add API documentation if it's a new feature +4) Update API documentation if it changes an existing feature +5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides + +# Asking for help + +If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b4c4156 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2015-2019 dry-rb team + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.