discorb 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57f5fd6920be7c5549687ec85d3012dede743981482fc806099789d3d9f4048
-  data.tar.gz: 513c3e45c0da27f8e509c4ed7238c5f6da3cd39b61a0681874a97d507068ffc6
+  metadata.gz: 2f43c7785e34661458d9837fd1e75877b8d343f8c920021624d92d0fb87c5ee3
+  data.tar.gz: f5b1ed37f600c0b2945d737a154c9d07155d38dad1b8c3da58fc209fa2db99a9
 SHA512:
-  metadata.gz: 7603b6c7017898fbd705ffaa602f370111c6d122a2e68a7b6c017c6fa622d9b6990e684bf574104844e8dc6601176a47894815cfb3756ae16305fe74709da118
-  data.tar.gz: 0fa148e0c26c45a8aa0c3a9e2dbdfb4995bc9e939c9588d93b575b711baccc906b20ba3f8edfe4906ae5838565bd0be6befc5cf7e6b2ca25f1f465e21fa6622a
+  metadata.gz: 42f7ffe2b1a851123d883f98223b7c8a755d40faff16a29c1eeecc58e3e023817c5a865bd2aaab52001a8311458a656e034de1f3349ed7778b033afd49840634
+  data.tar.gz: 3a6789362788a6c16e38ead2f6d463162f6e852da84df703ef90e32e27477fafb3ce611c931c9f1d9516275f21fb7229e4cec51b0110720b870a2d30f474120d

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## What does this PR do?
+
+<!--
+Please describe the changes you are making (be as descriptive as possible).
+Ex: Fix `Foo#bar`
+    Add `Hoge#fuga`
+-->
+
+## Information
+
+- [ ] This PR fixes an issue.
+- [ ] This PR adds a new feature.
+- [ ] This PR refactors code.
+- [ ] This PR has breaking changes.
+- [ ] This PR **won't** change the behavior of the code. (e.g. documentation)
+<!-- If you need to add more information, please add it here. -->
+
+
+## Checklist
+
+- [ ] I have reviewed the code and it is clean and well documented.
+- [ ] I have ran bot and it is working as expected.
+- [ ] I have updated the document.
+
+## Related issues
+
+<!--
+If there are any related issues, please add them here.
+If there are no related issues, please write `None`.
+-->

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to the project
+
+## Submitting a bug report
+
+Please follow these steps to report a bug:
+1. Check if the bug already exists in issue tracker. Don't forget to search closed issues too.
+2. Create issue from [the template](https://github.com/discorb-lib/discorb/issues/new?assignees=&labels=bug&template=bug_report.md).
+3. Fill in the issue with the information about the bug.
+4. Submit the issue.
+
+## Submitting a feature request
+
+Please follow these steps to request a feature:
+1. Check if the feature already exists in main branch.
+2. Check if the request already exists in issue tracker. Don't forget to search closed issues too.
+3. Create issue from [the template](https://github.com/discorb-lib/discorb/issues/new?assignees=&labels=Feature+Request%2CEnhancement&template=feature_request.md).
+4. Fill in the issue with the information about the feature.
+5. Submit the issue.
+
+## Submitting a pull request
+
+Please follow these steps to request a pull request:
+1. Check if the thing you want to request already exists in main branch.
+2. Check if the request already exists and is merged or closed.
+3. [Create a pull request](https://github.com/discorb-lib/discorb/compare).

data/Changelog.md

@@ -4,6 +4,11 @@
 
 ## v0.12
 
+### v0.12.1
+
+- Fix: Fix some texts
+- Add: Add `User#mention`
+
 ### v0.12.0
 
 - Refactor: Refactor the code

data/lib/discorb/client.rb

@@ -420,11 +420,11 @@ module Discorb
     #
     # @param [String, nil] token The token to use.
     #
-    # @note If the token is nil, you should use `discorb run` with the `-t` or `--token` option.
+    # @note If the token is nil, you should use `discorb run` with the `-e` or `--env` option.
     #
     def run(token = nil)
       token ||= ENV["DISCORB_CLI_TOKEN"]
-      raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
+      raise ArgumentError, "Token is not specified, and -e/--env is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       when nil
         start_client(token)

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.12.0"
+  VERSION = "0.12.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/user.rb

@@ -26,6 +26,9 @@ module Discorb
 
     include Discorb::Messageable
 
+    # @!attribute [r] mention
+    #   @return [String] The user's mention.
+
     # @private
     def initialize(client, data)
       @client = client
@@ -43,6 +46,10 @@ module Discorb
       "#{@username}##{@discriminator}"
     end
 
+    def mention
+      "<@#{@id}>"
+    end
+
     alias to_s_user to_s
 
     def inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - sevenc-nanashi
@@ -77,11 +77,13 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/build_main.yml"
 - ".github/workflows/build_version.yml"
 - ".github/workflows/package_register.yml"
 - ".gitignore"
 - ".yardopts"
+- CONTRIBUTING.md
 - Changelog.md
 - Gemfile
 - LICENSE.txt