From da339b4ec2dc6da04c5889f31441156978a4bef7 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 09:19:48 -0500 Subject: [PATCH 1/9] Change warn to error for arrow spacing --- .eslintrc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.eslintrc.json b/.eslintrc.json index b46b74b..4fc98d9 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -12,7 +12,7 @@ "es6": true }, "rules": { - "arrow-spacing": ["warn", { "before": true, "after": true }], + "arrow-spacing": ["error", { "before": true, "after": true }], "brace-style": ["error", "stroustrup", { "allowSingleLine": true }], "comma-dangle": ["error", "always-multiline"], "comma-spacing": "error", From a6590567fd3412310a3811c32eb641859f03f6fc Mon Sep 17 00:00:00 2001 From: Abheek Dhawan Date: Tue, 29 Mar 2022 09:27:38 -0500 Subject: [PATCH 2/9] Update scripts for TS in package.json --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 92ec7cd..e1a4ce7 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "name": "awesomescibo", "version": "4.2.1", "scripts": { - "start": "node index.js" + "build": "yarn tsc" }, "keywords": [ "discord", @@ -27,7 +27,8 @@ "science bowl", "discord.js" ], - "author": "Abheek Dhawan&Tejas Chugh", + "author": "Abheek Dhawan", "license": "MIT", "description": "A simple Discord bot that automatically generates Science Bowl rounds using the ScibowlDB API!" } + From e7b5268140ef64762856476706c6c622057b433f Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 09:46:38 -0500 Subject: [PATCH 3/9] Rewrite README.md with updates --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7415a08..4d74514 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ + +![out](https://user-images.githubusercontent.com/67982792/160637166-b8c3a390-e4f9-46d1-8738-dcb2d8b9baa7.png) +

AwesomeSciBo

+

@@ -12,25 +16,23 @@

A simple Discord bot that automatically generates Science Bowl rounds using the ScibowlDB API!

## Deployment -Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using [this link](http://scibot.adawesome.tech/). +Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using [this link](https://adat.link/awesomescibo). ## Contributing -Please see [the wiki](https://github.com/ADawesomeguy/AwesomeSciBo/wiki/contributing) contributing page. +Please see [CONTRIBUTING.md](). ## Installation -Please see [the wiki](https://github.com/ADawesomeguy/AwesomeSciBo/wiki/installation) install page. - -## Usage -This bot uses slash commands now :). You can just click on the bot icon after typing `/` to see a list of commands. +There are basically two ways to install it: -## Notes -### Creating a Discord Application/Bot -To create your own application and bot using the [Discord Developer Portal](https://discord.com/developers), go to the previous link and sign in. Then create a new application, and click bots on the left. Configure it to your liking, and then copy the token. +### Method 1 (Node): +After cloning the repository, dependencies can be installed with `yarn` or `npm i`. The bot can then be compile to JavaScript with `yarn tsc` or `npx tsc`, and will be deployed in the `built/` directory. Finally, the bot can be run by entering said directory and running `./index.js` or `node index.js`. - ![](images/discord-developer.png) +### Method 2 (Docker): +This bot has a Dockerfile within the repository which can be built using `docker build . -t [tag]`. Alternatively and preferably, the image can be taken from [DockerHub](https://hub.docker.com/r/adawesomeguy/awesomescibo). -That's the most important part of your bot *and don't share it with anyone*. +## Usage +This bot uses slash commands now :). You can just click on the bot icon after typing `/` to see a list of commands. ## Credit The bot was made by [@ADawesomeguy](https://github.com/ADawesomeguy). However, the API was made by [@CQCumbers](https://github.com/CQCumbers). Go give [his API](https://github.com/CQCumbers/ScibowlDB) a star, he totally deserves it! From 872eb63169033d1feb465714421ba6245180a7a4 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 09:55:15 -0500 Subject: [PATCH 4/9] Remove unused image --- images/discord-developer.png | Bin 7740 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 images/discord-developer.png diff --git a/images/discord-developer.png b/images/discord-developer.png deleted file mode 100644 index 6d18a4c441ce375a1d1ded14646798ed162eb059..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7740 zcmcI}Wl$VZu2M8=qaCdhLZozeN7I%kb_j2pK zAMe%ub8o$RKjuuIIdx{btNZ)9`%JjX7gz5)Oe`LmpehWtDpq&KrZ z-(EY*>9_#^*5CiUkP?}(NCANSL|*Enx>x!!#M2MgGn4=9)OsdOgQZ!k%B43M>*X{V zl?2*r`rx`T3w95^VTNYNh#}~5JM+kG$l<1W%+Pf|EhGtt>U9V~i9;$Tk@G1e-u~Kf z7ygU(&GKN4D3No=DHu^@2`#)o;D4|#;rW|>ABjXQ#oRx}24ufRa|^|J;?P2y#QvWM zvBah;lt%ucbVJm#y!?%Rupx0|Y&X{$tBKTNbtVD*ib><5;&N6dF^AeEWL((csnMpZ z_bY62whw|^lr_#D;lqg|NXDnDPVD+^brvH}Iw`~`(68$1es_bDdwY9EBA4dI!(9tD z&CR6ztEIF1@Q3-%=p$)b_wS*@8fXgnQwVJNcvAkAw1fn5B79=vW)3b_-IKaNznf;= za^f0q1%(T8PZpFQZmV%rS^7HRQ+-3NHDkUsSuO5QTMX(It3HPgRA|7@*hv4gZdTw7 z{z$ox8MbbN{sz3WZLWsr0lOQjc|&OMMe88%cfDu%+wc%<`({K&XXh@c^_57uHcN-o zv`jo5X<8~4g%FuYNlS~*{Jbv;cDtd|nKm2P^LB|>ukn~@mRZ^w7P8b?qg_rA*=Jh4 zaEyh(DIK%Ce+!_YeuLe+A+3+5xD6<$^Q4V^0oS&)SU!$t08|M>mgDJS>w@y}D{bBh zD)0XtxC?t8UEKS1oB4|k%g&Gqc zV9a-0-to=D15{X$_dYSM8^z77u)qJW3f}c~1w=G8vs*biBjY;I(03MrINxH7Ar~hW z0jrG>>7f^V&?ZdtoHg4-o^qNL}kHNI`wJNB|a?P=wFs) z%>P0z)O6iVx9k-b1#(b&`cb#trw~VSGhL&_BR&8Jt6qZv4;|?8K29D)NbcJb6xQiGmgQ z`8TI~G9o$#6_~9bSj_k`FrH!50&z@Hud$ha`HkvjUC#UA%Uo(VRA9}oc4EUlLaL`P z^3DH#g{y{+#_{Dn5k~(v)cfw&{D=J2gS$g=2h>EsLOZT0^jzvE! zJN?uY_Vn9v7VtB4g133+CRctb6!tl~BSM$mdr9NCc`8@CXb&FosD;M-i+1DgWc-%> z2^T*AflmEkQh}303H|>nK;AXyyo6}KfCwxsZv|!QFXp?<>a9Az-pRGryB}OOxYx7( zV1`_@eCG5}Hwmi(CA;t6TTGmGxJ<;tdRk7Aq&cqk??szOj^pGVgMYhgzbJVajL5A? zr9sGM{b1*0gno_cu(C6_2?-efcBCB8=ZX<%B*QOG19P37KHWSJrqyK&T{90#+EKQ% zT-iZnoiz!_)YqLT9WAoU&ks6+{Js-?wUoD0#->Xkkwjk^&xUSo?j26;H9ORab61EECb}fgEj@djdN6XYpICv_OYxs^) zEl{V3mL?~bW@MmXOu+k;6jNsXgJ#8ykCoHRg@TsHI$~=?k*hc9M84v_0sU zSk-S{WOv~tNe6Nte3B$((8BvTQ;E>Bl2X4Z?1bJnybNPzr*xOg@mCuERURJ`@XP%Q zMQ9`sf5Rg(&@Wcua6*n`TubyS$p^Z$z%A_LXhMDFek@|(yKWLWKgL;TIyX4<_0$0eEbeNPX&odotfQ1?w^>4DY*r+o81D=1dfM zCnb*VY?+5cs4^fiuqi7{AU=HPknu3d4OcbftK>!?8CV9Vv76}C)f^;L7kb81SlyxG z8uD)~?R(hVLoQEiKg1`4BJ1Gpu;Pj2FQuJPG19S0h-JyV*1*6ro3TqiZ_{zBi3iFh zydm<)0852YYCl6&UyGh_Wt379Y}r3!hB?YT7l|g9fkb9#fo@CyzT?|{?w(Ura#UY+0-lA>^oR} zYBmQqILCXb!^?f{SSu=+@Baz2M6Ob#6lHdV+3-t){c%Nz`>06gJFH_yMptgQl;=6u zWO$6q7B9luEv2Wv!4qm~tVu$2KZm6~9P1N$-SpsI#1$fPtPl-CR zPYDEr3`nfh3gjXm*T_;=63a)jBG?~jJl6CagX_xA&X*pICLUm@-!9}2CmL9NS2(<5 z+8(xJQLC;JcKh)IHv+9S3N*#fC~KBBM;+Kvf^5gb4t~ICAE&JZ8F&E!dd>r4&ymtE zQU)s%b!kfB&BuxqW{Vhc_yaQ2wcn$P_(xrI>TjRqbpoi)?*=yTumL{lgV}-AIG&_} zz-!qg$V^ISzRR&9EH)EL(qdB_*n^hH43@(J?9C>Kb|-xXaFu@0n+=>28S(>Yt#-7` z0cXxq-P0-X&YN4Uf^69RXl ztjHd{vw;t-K65R}mqtdFbP*qsgVNY}8ODe^>Uh`r=6ON%RhfK&2TtsOu7LyNnz-}ziu*S|iLpx9o;6$GJ< z|C*Ib&yeyg_k1d@D~A@!bLDW+c@OlvlT7yFlc-tBfKSeU49ET{T9-T%i(hoU9RW!z z%n`C<5|`k(6QkBFy+bSy#uhq&c{1lM*;)*78{gMl^*JdT!5UzM2y315sJvp9!%ISB zJ%xhpeK7)Mmwbc@>2eM}NR#xd*5b{rLJ2n7AZ)vjA#UdEMD7~!>iqax?q3EVE?ULjhJtyL-Pr1c;zE(ib&_W z7zxFDiBIjK?vU3+7gG)NG%3qPdI~3u$!6Xk^p*OjgY<)r1a0#offAKJJK6rDRWu^d z`?KodMd6hil(~ZJyrwB^s8;Q^^O$lc>L*fA!R!QoxlcnU>-Rjlq}Y#KeujW^1P$-> zJQ2f0{m7;cRzj>fx_UIN|Li=jr4vutV@6S~YZnPi`lf2~C+M){rmb*PF?TN8G3gUo zPm`^T%T5(9L;HROAy;F^-x^{W@yhkZuQML9_aev|qJR<{8hyYT=x7A9-VBfZE`y8F zNV}V0gl*k-b_J>{ycpfg?w+bgdUK51xahm43<@R5)SFlYkRn^ zL{qC=;T(9*$Dn?Bgp&l#+4pWDFPi=KIMns>UBygl+YRk(fmnMdjTyr<#*~pGX9CS(73-br9yaEEs%oYcY3y^BtVy%!==Phg7!Y9H!sTV% z4oM3vi|v^`-ZdJIFTjO$4CDm}bEDLg+o^5X6d?%kO<(NwHrr|7MlXJB55H1H4%^9= zUFzZKQ#&h{P1k#{M2Vsi#}S4$Rzg#~KCf?kY#a1~__kgcKW{k`zEg@fRJMF&`x93x zWP-FwcUW0duS|KuQ$`9kY+>j1!%XwV$23XFh?cANwoUEJR4ei+ZN#sibFN_{6{-GC zXXbd{c?NE?)+4Mt25ZuMTu*rzCeXyTyK0C-Gc*o#4qxgo+bSI_W4Osk$=3aT)vx-3 zvn7(Lk`cE0ODjuB=tg{uIUql+hGTS7^=_~!WE&^hkNtu11L?oaA~W#>qS*E-rbo4Nl_#v0J{$7Q zr~jJPylYZ>x7A4|&uf<6Tk6DiKMBdu()f( zh>hIm@MQ7%OaF_r%@JFxOgU|>4k`$iqb_CMKP33GLgRg#er@k|%Demv@bgf+UBP^2 zgS_bzGndhDwdEwy)r3Z&0(Wd6IlgcaZz#Us4I_5>S@$-mU@J|E1+SFmO=vB5U}W7! zy2Lb|Pj#{7+Q{KE=NJ)j_${nfeNe;PzuZ!2KnkjAr2v-Dvv5H357>mEY+_9g61Q!i zb7B-!tvvR=1=@yniv4n!wDiBRcREpUu>80@mG!7CQUG~>RF?9LhpDqKXcz9}I$5G? zs%Oq4!$v-W$PMze<>I(*pm~+cgN%zEN?VFMH>>X6*No4t$j8lU?6gyu$FYAU=W#*X zEd{Ng;neZq0-QbL4W+f-Lz5nrNt*AD#(%iMDHgCJjX_y04#yYId&Rv3AIG-6*=naLf;S(ukLNBKc z9i|oIvG24vp9jK7_f1yY#oa4_N`+S{Yk7-c2-z;Gn$*VWZ^r7$hAdCHH}&&o0S1q~ z=ivG&cuBZ+MDjAH-^)5sU4$$+(Bcu-T}{Z(w3WVNUZCr7L0@nmO?93KWX(&*d-aYU z(xi|v9r=DWwfe%*%jPdK9`oNnig3Dn9G+BUvLqP&ZJvj2{+0z*GI>Uv1@lfCvTIBlx2xFXy#E=o ztu%o*HWKND7>Rk%^iz%+g(tLYwu0$i>%6e@DcDP4J#WRf`vN9)0vT*sZ7I;lN(R7> z&u*%4*EHyfRrv$l5$Alddm59J4V?GH32t>B&@pRhO zJU$Z>2@AuBaz1w=SHplL(#8-4%xa zuF+(VP*UFHCX(`uz1-6=&@e-^CkNge_sj|@>V>g$}~#c502kgUjlu^X{tF-hvC zS|1~vhQmxE`=AB}ID)(ecRL?FG;$L^O30K@u}l8O8H@X=gH>3WKhl9PcdA^)1l-*E zZXv`wfnf;0517E};@sql33egWMWUac&d5pMv>)O=23_459+t85AgYX}3oqm!*i|A( zXX7U@;wkbm;I8d^Q=s_lEI!$_VK&zAEM9p5e*PZlS%7CwW6@}r>AOR8d^W<_sT}}7 zHx4kAl1vk=dPD*)3#9Yt&prJrLCyP%G)|@WY_M>fBPBpCV#hKM?Most**F|Cs9q6Y zLC|UfTNF!ct&3PEM|Q4HlTSM~eNKa4M{U!~lkK+_|Kg}7JAm^-q?VpqG`#cF{4{P_ zH>2C%D!9$K;IHZB%>kr-j1Tx3UmJL-lCuaERhjXv9vw7YtjUo1Pw?`>EuxOhi@k;Jae`@EZS_dOPz1_Tl zhcyK;Hc8PN%M79bSG!2h1go_VOdLK*mXMTndJC99xcXX!g#aqMcq;ms$CH?tFg{`6 zYHx+0^)~#o3q2SEP7OG(WvH?m++cfp+*8igFSHrjLb#;8>jlrw@p8BAmkV3;mm9x5 zT>SB|ZQ)@2ypRnFQwv*r*cp!S8JY7h>B{`Jc;J8BnKn8H-^rh9$y~rAr0lcVcO@F5 z$X!$um^eIFfyV{~Ioozj_M0Ihx~YJmpem3T6dF-VQWpGtF1C0e>SCDnZbEHXJ2;qv z9Um=mt@zE$XN-S-2L#1_i`0PHsD;oi@~bt6B;t&HDCLNL+F23G4CFblH~Q?eQ~aBe zukYM@o3XVug6+y_6Z-jW9LD?R8SxP0_vJjw3hUYa(9@-4Y;p}DURnB#L^<$V_Kppr8*?Ixk zym(W=KAP%O_w3(AGQ$YuxF9l+LR?T34re4g)(YZ0>m(``YU@7#Bq~+DdVC%Hb@i6} zUA|Uyq@_HU8Y=!Z0Wdg%BbeSX9OeQU?3ipgQA;UbMV+Q~oeJ@dv4$;oA-PPFF(i0x zH4l9!Rrssq8>{H#jtiiF5UwiSIu(72wQIY3&jyHiAaFXpXy4pJ3*J)&!0^Z$Fc1iE ziIOD6^kx-tN-=C(z%c3?Ew~B@dV6u{J;OU~C*rzu8C){|Y%(cG0r6@fNcjWspTMY| zmqZdU5QD}t7gbPbf%^ry6}Km5uas21qZhZ@@h3c@blrX!I9=40l66Ky#hUmY%9WSW zE8w>bvArD0qLls+-lpup`Oci~lF8=AvhdXoqx`v+9NNV+E$QO=is6TjL~L*`5Omvl zK-MOulvLGl(EEWlq{q9a$NMY#pN>AwdDHque^M>1OSSI084=KyyGT{Zv<^GhGZkkPY?`LzC*V(^l?oXMR6J{GNbYAfpopD|4* z+nz37Jq0psU`Zn;o8($vaU1tV9q9U$RlkS__eGqrw1B8&9&b~cuq1D1Ij^TsfIxX# z3VmuEJvzqGlt2ny+`9qHNed zT=;1$LDq;im+aDv33jzxpXJ+9LfL1g#QaD|tb4qg%5WIP;_^%^Wv-vdtBH=zY#bB| zpEGa1`bs0FYxCUZxe7Dk@b_C;ZKX}PaPC4`hY1Z*!gB_-lvmsI4h}=IEiaWkW=a0= z_N+q3{EemDR6?)+R+w7Ztw`2@#m^Vpc`x8kr8(xNbA`UG7*M;0Y*E7!=S=l3T2G393zCj9F+JrV zcuB`>QWm59=XJ1Va#x`K_`!!{`p=4+YIt{*V~{o>1qPFhPFr{1_W;ht&@<0`<+Rg` zX)+Eo-@uU9$CI^keO19>e+n8Mi%w2qeF?+`jmo{X*RDv<{J>PoaX*1MJ`{cCQ~X8) zx_*Ifsc^-hEZxqV&IQ}8JkWDM;d}p^>n4gtwXlER*=H+Pzz)n*U=`t|Uz4*s^|Un^ zV~xtlF1ej6!9th8met80R-Qt@kAP`NoJ&hO)Ycm(@rb5~^BTyh{|7LngSDV%+=7W~sGW zduv!MtB+oHxUqUx7XnevbE7m!_fE=%CxRt{{`;w?i5&8q`B{v-4a=Ss$;m&w_ul#J zE1#XdnMff)k}znw(X9_>9UU_e1DkVniS9k1yhK@G>Gz_D&-}%3R6pTOOcS2m>>3O+ zFJ2{f_1!9zFZY1)vDQbzhE>6gxn4;n5vD#lT{>81;Q5-5S41u(!Pg>x+m%u3Ix_se{UP_P)>aYUb- zX%Z_f34!o_yu)*Qym(kwPcg{}u!BNV*B`aeAb82lA$vcXKm82&uR^w~#T0L}9(iL% z90&^pmEt;@!boJ!C`q3)W%&JnJSvT8K_T#GF27d7A&|6_g#^Fl?H*6(=+Sw|?wCgd zQg68F5_-+w=-9(%odBR!dU`sbpy5a|g5)Df?L%Ms{5u$sm;NGE@yYnxe*g?GX>I@j From 2bac614d94b80eeaf7dd0a6cb82091080ad6b0fe Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 12:30:47 -0500 Subject: [PATCH 5/9] Add a Code of Conduct --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e9bb389 --- /dev/null +++ b/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 +abheekd@protonmail.com. +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. From 9789d477a91e92565669dc1a869c3d6ec0dc5d3e Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 12:42:50 -0500 Subject: [PATCH 6/9] Add contributing guidelines --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9a197fa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +## Cloning for Contribution +To set up the development environment to make changes to the code, clone the repo, install dependencies, and run it directly with `node` as Docker doesn't expose as much. + +## Making Changes +To edit the code please keep a few things in mind: +1. Be able to explain changes you make; they should be legible and understandable. +2. Please try to abide by ESLint's rules, setting up ESLint is quite easy to do and not too difficult to follow. + +## Testing Your Code +For testing, make sure to set up the prerequisites: +1. MongoDB: have a MongoDB server set up. +2. Environment Variables: take a look at the `docker-compose.yml` for examples. + +Once that's done, you can run `yarn tsc` or `npx tsc` to build to JavaScript in the `built` directory. Here you'll find `deploy-commands.js` which you need to deploy the slash commands, and `index.js` which you can run to start the bot. + +## Submitting Your Contribution +Creating a PR is easy enough and there are plenty of tutorials to do so. When contributing, please make sure to highlight and explain your change, with any import information additionally included. + +--- + +# Thank you for any contributions! + +--- From b73a46183c7aea260538888098b5a7aa38b18ce6 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan Date: Tue, 29 Mar 2022 12:44:00 -0500 Subject: [PATCH 7/9] Move guidelines to .github subdirectory --- CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md From f732da7de6d38db750a27205cb4adf73475802d1 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan Date: Tue, 29 Mar 2022 12:46:11 -0500 Subject: [PATCH 8/9] Update README with link to contributing guidelines --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d74514..63f3de4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -![out](https://user-images.githubusercontent.com/67982792/160637166-b8c3a390-e4f9-46d1-8738-dcb2d8b9baa7.png) +![logo](https://user-images.githubusercontent.com/67982792/160637166-b8c3a390-e4f9-46d1-8738-dcb2d8b9baa7.png)

AwesomeSciBo

@@ -19,7 +19,7 @@ Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using [this link](https://adat.link/awesomescibo). ## Contributing -Please see [CONTRIBUTING.md](). +Please see [CONTRIBUTING.md](https://github.com/ADawesomeguy/AwesomeSciBo/blob/master/.github/CONTRIBUTING.md). ## Installation From 83e9b4d07faa295a9305ddccc3bf390ff4f8757a Mon Sep 17 00:00:00 2001 From: Abheek Dhawan <67982792+ADawesomeguy@users.noreply.github.com> Date: Tue, 29 Mar 2022 12:51:42 -0500 Subject: [PATCH 9/9] Clean up CodeQL analysis --- .github/workflows/codeql-analysis.yml | 66 --------------------------- .github/workflows/codeql.yml | 25 ++++++++++ 2 files changed, 25 insertions(+), 66 deletions(-) delete mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/codeql.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index 86e717d..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,66 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -# -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# -name: "codeql" - -on: - push: - branches: [ master ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ master ] - schedule: - - cron: '43 14 * * 0' - -jobs: - analyze: - runs-on: ubuntu-latest - - strategy: - fail-fast: false - matrix: - language: [ 'javascript' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] - # Learn more: - # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v1 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 https://git.io/JvXDl - - # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language - - #- run: | - # make bootstrap - # make release - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..c4e353b --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,25 @@ +name: "codeql" + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + schedule: + - cron: '43 14 * * 0' + +jobs: + analyze: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: 'javascript' + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1