From 031d60812ada61c045e5be579eefac20b808607c Mon Sep 17 00:00:00 2001 From: Troy Benson Date: Tue, 31 Dec 2024 18:20:23 +0000 Subject: [PATCH 1/3] add docs to readme --- README.md | 2 ++ docs/README.md | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/README.md diff --git a/README.md b/README.md index d0e18cd..62f0786 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,8 @@ Inspired by [rustc-perf](https://github.com/rust-lang/rustc-perf), [bors](https: - [ ] Roll up PRs (roll up multiple PRs into a single PR) - [ ] Performance Benchmarks (upload, compare, dashboard) +For more information, check out the [**docs**](./docs) folder. + ## 🤝 Join the Scuffle Community We ❤️ contributions! Check out our [**CONTRIBUTING.md**](./CONTRIBUTING.md) for detailed guidelines on submitting improvements or bug fixes. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..db06356 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,17 @@ +# Brawl Docs + +## [Setup](./setup.md) + +Step by step instructions on how to get the bot setup & running. + +## [Commands](./commands.md) + +A list of commands that the bot currently supports. + +## [Configuration](./configuration.md) + +A configuration guide for the server aspect of the bot. + +## [Repository Configuration](./repository-configuration.md) + +A configuration guide for an individual repository where the bot is installed. From 8867f3ba9fa94bd9a5e15e47e94a50573fc7cd7d Mon Sep 17 00:00:00 2001 From: Troy Benson Date: Tue, 31 Dec 2024 18:20:38 +0000 Subject: [PATCH 2/3] remove CLA --- CLA.md | 56 ------------------------------------------------------- README.md | 5 ++--- 2 files changed, 2 insertions(+), 59 deletions(-) delete mode 100644 CLA.md diff --git a/CLA.md b/CLA.md deleted file mode 100644 index 48aecd9..0000000 --- a/CLA.md +++ /dev/null @@ -1,56 +0,0 @@ -# Scuffle Individual Contributor License Agreement - -Thank you for your interest in contributing to open source software projects (“Projects”) made available by Scuffle or its affiliates (“Scuffle”). This Individual Contributor License Agreement (“Agreement”) sets out the terms governing any source code, object code, bug fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or other works of authorship that you submit or have submitted, in any form and in any manner, to Scuffle in respect of any of the Projects (collectively “Contributions”). If you have any questions respecting this Agreement, please contact opensource@scuffle.cloud. - -You agree that the following terms apply to all of your past, present and future Contributions. Except for the licenses granted in this Agreement, you retain all of your right, title and interest in and to your Contributions. - -**Copyright License.** You hereby grant, and agree to grant, to Scuffle a non-exclusive, perpetual, irrevocable, worldwide, fully-paid, royalty-free, transferable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute your Contributions and such derivative works, with the right to sublicense the foregoing rights through multiple tiers of sublicensees. - -**Patent License.** You hereby grant, and agree to grant, to Scuffle a non-exclusive, perpetual, irrevocable, -worldwide, fully-paid, royalty-free, transferable patent license to make, have made, use, offer to sell, sell, -import, and otherwise transfer your Contributions, where such license applies only to those patent claims -licensable by you that are necessarily infringed by your Contributions alone or by combination of your -Contributions with the Project to which such Contributions were submitted, with the right to sublicense the -foregoing rights through multiple tiers of sublicensees. - -**Moral Rights.** To the fullest extent permitted under applicable law, you hereby waive, and agree not to -assert, all of your “moral rights” in or relating to your Contributions for the benefit of Scuffle, its assigns, and -their respective direct and indirect sublicensees. - -**Third Party Content/Rights.** If your Contribution includes or is based on any source code, object code, bug -fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or -other works of authorship that were not authored by you (“Third Party Content”) or if you are aware of any -third party intellectual property or proprietary rights associated with your Contribution (“Third Party Rights”), -then you agree to include with the submission of your Contribution full details respecting such Third Party -Content and Third Party Rights, including, without limitation, identification of which aspects of your -Contribution contain Third Party Content or are associated with Third Party Rights, the owner/author of the -Third Party Content and Third Party Rights, where you obtained the Third Party Content, and any applicable -third party license terms or restrictions respecting the Third Party Content and Third Party Rights. For greater -certainty, the foregoing obligations respecting the identification of Third Party Content and Third Party Rights -do not apply to any portion of a Project that is incorporated into your Contribution to that same Project. - -**Representations.** You represent that, other than the Third Party Content and Third Party Rights identified by -you in accordance with this Agreement, you are the sole author of your Contributions and are legally entitled -to grant the foregoing licenses and waivers in respect of your Contributions. If your Contributions were -created in the course of your employment with your past or present employer(s), you represent that such -employer(s) has authorized you to make your Contributions on behalf of such employer(s) or such employer -(s) has waived all of their right, title or interest in or to your Contributions. - -**Disclaimer.** To the fullest extent permitted under applicable law, your Contributions are provided on an "asis" -basis, without any warranties or conditions, express or implied, including, without limitation, any implied -warranties or conditions of non-infringement, merchantability or fitness for a particular purpose. You are not -required to provide support for your Contributions, except to the extent you desire to provide support. - -**No Obligation.** You acknowledge that Scuffle is under no obligation to use or incorporate your Contributions -into any of the Projects. The decision to use or incorporate your Contributions into any of the Projects will be -made at the sole discretion of Scuffle or its authorized delegates. - -**Disputes.** This Agreement shall be governed by and construed in accordance with the laws of the State of -Delaware, United States of America, without giving effect to its principles or rules regarding conflicts of laws, -other than such principles directing application of Delaware law. The parties hereby submit to venue in, and -jurisdiction of the courts located in Delaware, Delaware for purposes relating to this Agreement. In the event -that any of the provisions of this Agreement shall be held by a court or other tribunal of competent jurisdiction -to be unenforceable, the remaining portions hereof shall remain in full force and effect. - -**Assignment.** You agree that Scuffle may assign this Agreement, and all of its rights, obligations and licenses -hereunder. diff --git a/README.md b/README.md index 62f0786..fb87724 100644 --- a/README.md +++ b/README.md @@ -56,10 +56,9 @@ We ❤️ contributions! Check out our [**CONTRIBUTING.md**](./CONTRIBUTING.md) Join our [Discord](https://discord.gg/scuffle) to chat with the team and other contributors. -### Sign the Contributor License Agreement (CLA) +### Contributor License Agreement -To contribute, please sign our [Contributor License Agreement](./CLA.md). -It's quick and easy—[sign here](https://cla.scuffle.cloud) before submitting a pull request. +This project does not require a Contributor License Agreement (CLA), all rights are maintained by the Contributor. ### Code of Conduct From 30d21cb14dd5922211f3a1489cce56b141dedaaf Mon Sep 17 00:00:00 2001 From: Troy Benson Date: Tue, 31 Dec 2024 18:20:50 +0000 Subject: [PATCH 3/3] reorder modules --- server/src/lib.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/server/src/lib.rs b/server/src/lib.rs index aed0e47..1865461 100644 --- a/server/src/lib.rs +++ b/server/src/lib.rs @@ -4,5 +4,6 @@ pub mod auto_start; pub mod command; pub mod database; pub mod github; -mod utils; pub mod webhook; + +mod utils;