diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..5803ae5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @Awayume diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f17ecf2 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +dev@awayume.jp. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..a8d7b41 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Contribution Guideline +Thank you for your interest in contributing. +Please check the following before contributing. +Contributions that do not follow the rules may be rejected. + +## General Rules +- You should use English in this project. + +## Commits +- Write concise commit messages +- Make your commits detailed. Consider splitting commits that are too large into multiple commits. + +### Commit message +Commit messages must always start with the following prefix: + +| prefix | description | +|:---------|:---------------------------| +| add | Add something | +| remove | Remove something | +| change | Change something | +| update | Update something | +| upgrade | Upgrade version (not libs) | +| feat | New feature | +| fix | Fix something | +| hotfix | Fix critical bugs | +| library | Add/update/remove library | +| perf | Improve performance | +| refactor | Refactoring | +| test | Add/change test codes | +| style | Fix style | +| docs | Add/change docs | +| ci | About CI/CD | +| chore | Chores | + +Examples: +``` +add: Add something +``` + +WIP commits are allowed. However, it should not be the final commit. +``` +[WIP] add: Add something +``` + +Exceptions: +- Merge commits (default message) +- Revert commits (default message) +- Dependabot commits (default message) + +## Pull Requests +- Do not delete templates. +- Think objectively before contributing. + +## Issues +- Do not use Issues to get help. You can use Forums or Discord guild. +- Think objectively before contributing. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..953a55f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,100 @@ +name: Bug Report +description: Report a bug +title: "[Bug]: " +labels: unconfirmed bug +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to improve Discorust. + + Note\: + Before submitting a report, please check the bot's intents, permissions, and network. + Also, please check if there are already similar issues. + + - type: input + attributes: + label: Summary + description: Please give a brief summary of the report. + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce the bug + description: Please describe the steps to reproduce the bug in as much detail as possible. + validations: + required: true + + - type: textarea + attributes: + label: Code to reproduce the bug + description: | + Please post the code that reproduces the bug. + Don't omit use declarations in your code. + render: rust + validations: + required: true + + - type: textarea + attributes: + label: Desired result + description: What is the result of the code above if the bug does not occur? + validations: + required: true + + - type: textarea + attributes: + label: Actual result + description: What are the consequences of the above code due to the bug? + validations: + required: true + + - type: input + attributes: + label: Bug reproducibility + description: Calculate the reproducibility of the bug and enter it as a percentage. + validations: + required: true + + - type: textarea + attributes: + label: System information + description: Please run `cargo -v -V` and copy and paste the result. + validations: + required: true + + - type: dropdown + attributes: + label: Discorust version + description: Choose your version of Discorust. + options: + - 0.1.0 (Alpha) + validations: + required: true + + - type: input + attributes: + label: Discorust commit hash + description: If you're using an unreleased version (alpha, beta, rc, etc.), write the Disorust commit hash. + validations: + required: false + + - type: textarea + attributes: + label: Additional information + description: Please write if you have anything else to say. + validations: + required: false + + - type: checkboxes + attributes: + label: Checklist + description: This is the final confirmation of the report. + options: + - label: I follow the contribution guidelines. + required: true + - label: I confirmed that there is no similar issue. + required: true + - label: I have checked that this issue does not contain any credentials or personal informations. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..739a878 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + about: Ask a question or discuss of the Discorust. + url: https://github.com/Awayume/discorust/discussions. + + - name: Discord Guild + about: Join the official Discord guild of the Discorust. + url: https://discord.gg/8kDvErkuTS diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..139a75c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,72 @@ +name: Feature Request +description: Request a new feature or change for Disorust, or requests for this project +title: "[Request]: " +labels: unconfirmed feature request +body: + - type: input + attributes: + label: Summary + description: Please summarize your request in one sentence. + validations: + required: true + + - type: dropdown + attributes: + label: The scope of the request + description: Please select what you are requesting for Disorust. + options: + - The whole of Disorust + - Discorust core library + - Disorust command framework + - Discorust event framework + - Discorust documantation + - Project management + validations: + required: true + + - type: textarea + attributes: + label: Request details + description: Please describe your request in as much detail as possible. + validations: + required: true + + - type: textarea + attributes: + label: Reason for request + description: Please describe in as much detail as possible why you made this request. + validations: + required: true + + - type: textarea + attributes: + label: Current situation + description: What problems are you currently experiencing? + validations: + required: false + + - type: textarea + attributes: + label: Problem with request + description: What problems can this request cause? + validations: + required: false + + - type: textarea + attributes: + label: Additional information + description: Please write if you have anything else to say. + validations: + required: false + + - type: checkboxes + attributes: + label: Checklist + description: This is the final confirmation of the report. + options: + - label: I follow the contribution guidelines. + required: true + - label: I confirmed that there is no similar issue. + required: true + - label: I have checked that this issue does not contain any credentials or personal informations. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f5f7474 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,50 @@ + + +### Summary + + + +#### What I did + + + +#### What I didn't do + + + + +#### What this PR will enable + + + + +#### What this PR makes impossible + + + + +#### Operation check + + + + + + + + +### Checklist + + +- [ ] I follow the contribution guidelines. +
+- [ ] This PR is a code change. + - [ ] Code changes have been tested. + - [ ] I have updated the documentation to reflect the changes. + - [ ] This PR fixes an issue. + - [ ] This PR adds something new. + - [ ] This PR removes something. +- [ ] This PR is **not** a code change. diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..fd9e94d --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,23 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + assignees: + - "Awayume" + open-pull-requests-limit: 10 + reviewers: + - "Awayume" + target-branch: "main" + + - package-ecosystem: "cargo" + directory: "/" + schedule: + interval: "daily" + assignees: + - "Awayume" + open-pull-requests-limit: 10 + reviewers: + - "Awayume" + target-branch: "main" diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..d109e88 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,43 @@ +name: Build + +on: + push: + paths-ignore: + - '.git**' + - '**.md' + - 'LICENSE' + +jobs: + build: + name: Build + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Cache Cargo + uses: actions/cache@v3 + with: + path: | + '~/.cargo' + './target' + key: cargo-${{ hashFiles('Cargo.lock') }} + restore-keys: cargo- + + - name: Setup Rust + uses: dtolnay/rust-toolchain@stable + + - name: Build project + run: | + cargo build --all-features --workspace + echo version=$(grep -m1 '^version = ' Cargo.toml | sed -e 's/version = //' -e 's/"//g') >> $GITHUB_ENV + echo commit=$(echo ${{ github.sha }} | cut -c 1-7) >> $GITHUB_ENV + env: + RUSTFLAGS: '--cfg reqwest_unstable' + + - name: Archive + uses: actions/upload-artifact@v3 + with: + name: 'onyxwall_v${{ env.version }}@${{ env.commit }}' + path: | + target/debug/libdiscorust.rlib diff --git a/.github/workflows/pr_moderation.yaml b/.github/workflows/pr_moderation.yaml new file mode 100644 index 0000000..3b7981e --- /dev/null +++ b/.github/workflows/pr_moderation.yaml @@ -0,0 +1,16 @@ +name: RP Moderation + +on: + pull_request: + types: + - opened + - edited + - reopened + +jobs: + verify: + name: Verify + runs-on: ubuntu-latest + steps: + - name: Check tasklist + uses: Awayume/github-pr-tasklist-checker@v1 diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 0000000..4f63799 --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,34 @@ +name: Test + +on: + push: + paths-ignore: + - '.git**' + - '**.md' + - 'LICENSE' + +jobs: + test: + name: Test + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Cache Cargo + uses: actions/cache@v3 + with: + path: | + '~/.cargo' + './target' + key: cargo-${{ hashFiles('Cargo.lock') }} + restore-keys: cargo- + + - name: Setup Rust + uses: dtolnay/rust-toolchain@stable + + - name: Run test + run: | + cargo test --all-features --workspace + env: + RUSTFLAGS: '--cfg reqwest_unstable' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9ce42ca --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +/target + + +# Added by cargo +# +# already existing elements were commented out + +#/target +/Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..8bd0711 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "url_parser" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..909d25a --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# url_parser + +## Now developing... diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..7d12d9a --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,14 @@ +pub fn add(left: usize, right: usize) -> usize { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +}