Update contribution guidelines

FrostByte266 · FrostByte266 · commit 08e1a15880b8 · 2021-11-07T14:49:47.000-06:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -34,6 +34,11 @@ If the bug report is missing this information then it'll take us longer to fix t
 
 Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have scope creep and it's probably good to go. It would be incredibly lovely if the style is consistent to that found in the project. This project follows PEP-8 guidelines (mostly) with a column limit of 125.
 
+## Use of "type: ignore" comments
+In some cases, it might be necessary to ignore type checker warnings for one reason or another.
+If that is that case, it is **required** that a comment is left explaining why you are
+deciding to ignore type checking warnings.
+
 ### Licensing
 
 By submitting a pull request, you agree that; 1) You hold the copyright on all submitted code inside said pull request; 2) You agree to transfer all rights to the owner of this repository, and; 3) If you are found to be in fault with any of the above, we shall not be held responsible in any way after the pull request has been merged.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,6 +8,7 @@
 
 - [ ] If code changes were made then they have been tested.
     - [ ] I have updated the documentation to reflect the changes.
+- [ ] If `type: ignore` comments were used, a comment is also left explaining why
 - [ ] This PR fixes an issue.
 - [ ] This PR adds something new (e.g. new method or parameters).
 - [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
diff --git a/tests/.env b/tests/.env
@@ -0,0 +1,3 @@
+PYCORD_TEST_MODE=1
+PYCORD_BOT_TOKEN=ODc2ODk3MTgzOTAxODM1MzI1.YRqwJA.qXrCAxh-19nYzh-9s7aHgVZnW64
+PYCORD_CERT_PATH=/home/nerd/Documents/git_repos/pycord/tests/pycord-cert.pem
diff --git a/tests/pycord-cert.pem b/tests/pycord-cert.pem
@@ -0,0 +1,17 @@
+-----BEGIN CERTIFICATE-----
+MIICszCCAZsCFAbYqlDW/pbPkfxI2sjcBz/ZyPC5MA0GCSqGSIb3DQEBCwUAMBYx
+FDASBgNVBAMMC2V4YW1wbGUuY29tMB4XDTIxMTEwMzAxMDQyM1oXDTIyMTEwMzAx
+MDQyM1owFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUA
+A4IBDwAwggEKAoIBAQCnuA4PKNWUJdtIqC6iCI7DXtRhS082YHPGc7M2iU2ex9t0
++/XniLbznKiigrt4X4sQXFngrqkW/uTWFYHprEPXZ6mxIlS3wr7sBLneXdSVqhzf
+5fIn1Gr+yMPpY1O9XgjTG7J80D5LIpD0IdS7uOicQtqrFRkXttqdElEyQHzGPV+A
+M2SO7rpqFFDheAgBwAq/rloipn6NP4A26uTHB/o4uRVLS/f8nRoOAQd4yVW38inY
+jdABMQhnzDvJlqwhbt4oACwVrb2Iai/PW1Y8OQ4BtbEmMbuZ66W8wPf30k18JqOZ
+GgoEGYQ7kc0a9sQZUUSsGVg2pUvaASA9eA4cJMR7AgMBAAEwDQYJKoZIhvcNAQEL
+BQADggEBACvk8ge4brMrzn4JJ/qPonfJH0o6UH8fxQG4p7ngch3J0POF/py76k2D
+uHZjcLH78JaMXXVWhlKwnljMY7Lve0ZGwsHsB0eFPr6CghkLpu7xByzfKxuLYTVq
+0qlyAAvf9IaFxUmXQHddoO5PKih2AgZee15fwEA0Ql6YVLQB7oXj5skddyhuytjv
+K2jvtO4I2KBeZ6+D3TKxmPMjF0M+FwLx21IS7gvOcmob4JtBDgjH+kPYlw19ZM+u
+Q7YoamxbeXCHpQWws+Ex5x2icu1LD4OtfhGY3U9ez8Lt1drrxuqchZzn992oYJ8s
+3z4+u35C33Seli/4TPgyh1WsGO3YVHo=
+-----END CERTIFICATE-----
diff --git a/tests/pycord-key.pem b/tests/pycord-key.pem
@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAp7gODyjVlCXbSKguogiOw17UYUtPNmBzxnOzNolNnsfbdPv1
+54i285yoooK7eF+LEFxZ4K6pFv7k1hWB6axD12epsSJUt8K+7AS53l3Ulaoc3+Xy
+J9Rq/sjD6WNTvV4I0xuyfNA+SyKQ9CHUu7jonELaqxUZF7banRJRMkB8xj1fgDNk
+ju66ahRQ4XgIAcAKv65aIqZ+jT+ANurkxwf6OLkVS0v3/J0aDgEHeMlVt/Ip2I3Q
+ATEIZ8w7yZasIW7eKAAsFa29iGovz1tWPDkOAbWxJjG7meulvMD399JNfCajmRoK
+BBmEO5HNGvbEGVFErBlYNqVL2gEgPXgOHCTEewIDAQABAoIBAGvg3Vou38Hc38FK
+PESI0Jsl4eF6+UZ2n8FkJj/L7RtWXfhPIIp+y37Co010XXU9r0sku8LjVWuvJC33
+w4oz/acNzH5dILTaFMfm+k7nd5eUxeHWG/42iWO8axcxhmlllLOFOzdBEvBtGWOO
+ZzEf7K6l6dTlSzCPsuoZIBT8mcVAJaDvl75mIsGPSWA8rSywGwOgLJnncIaQgUKs
+rsQqSeSZXwsWtNMYjJSEJ74yd33Z5s0v1MqtqcLtCYWHPw2rCTBoGrwtIfGigK/F
+WzHCDvUwCel/oTk5uD0lmnjADYzphXOa5IfDxtfrsSMGkC3djZP2/aJj4KlvH0kh
+VPe3U+ECgYEA3DU0qrKzNMw/7x0vwoskfNXKheIVymXB/IqHP5NKgYcoQwbiiGgU
+uptkNAx9UkLriOroWu/QS69U0WsjfFPAxRzP3LXJoUaGJ7g/Kx6MzWLRtA0o9ndi
+ToeRMEN9wv3vnvZ6kUE+PkdERHEJ1UbpUHOweVgWj9out6VtLzZ/QdkCgYEAwvrM
+04yLMTp2okO6tsbS5KAJETM3c+b2/KoCTIsyVt+5iWakAQ2n5L4xPE0UoUFZPclZ
+tARnO4t/Ud39ZFEikntyHznyrDG74ycePVDfXs7TFkRZdpswQ/zUlzc2MteQ648m
+oYTZgibEGJnYmvzuPi4Oz5TVrCQRE8b7lys9sHMCgYEAxTVRCV4oZ6xTxYzZ7Nw3
+vSSpzuT+ptgitkxJe4IpQ38La5uK3KZ5ifUH9CULRtRvo5rcpDQI0v8ecr4EdZ98
+EAsRjJOxEyHZm1DCIZemeXl6XEk82h1oiPOX7yVCR5KrOi167wMC/ztLxA+Hwt1S
+rZ4t+T4OVp4LIKSh95pStWECgYAZmQujCmSLxf0lOHce3+N4GHqYQ30YPk5WxYsf
+uXaWaTDWlR8a9EwCf+W+4O/Aa+/naLPaKmnTK3E/skE+FljPml1VNCpj6POd0tjp
+e+CXddfIqJiGNcGUa3ENmTYIXryr8FNGCUb1C1nbUPdbAbHVf/55yjRzMRj827bU
+Fd03eQKBgAJWLP9QX7cLJHcrbVHWK2tQNixbDE4f1fCZrPgaIwRold1/QvdLIsb9
+LLtGtZGhdinUi7/bwMBI5gICOcRac7uvp+nkpCFYvkj1tBdEdcbGGFZRjhYjuU68
+K3OtXoZE8L/j01jdZ0/6UPRUGZuSMtDxTEz6HipP1fdo0bgvw+55
+-----END RSA PRIVATE KEY-----
diff --git a/tests/pycord-signkey.pem b/tests/pycord-signkey.pem
@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEA4Z91H0Gpurnre4doELPhKkqmSePN9+uNGOM70aY7T9Kz1gVS
+ncPU8wu3AyRfUyEXyAq1L7r8re8wtxS4eMnA3LKeyUP8WCzqBuzSvDSg3sk5A+Gy
+vAoujcvifyZIULVlkQQvdzrz/qfDAhlt/wrKW3N5u2Dps6hMqpngF9YlXTZKsNWV
+raMyTqI9jVzU0BdP14RhitqxKdZ8wkdgt6Dq6nPZ5ibpMUfDXiZ0SA1skRKMFgm5
+5iW8gAGJR38cSRdM5lnypCUlZn68tjC1zHQPOvd0yakrwow7+E92CrxZls9kYOew
+xutrzpsLE8bec9JwWFsEUYSmfDIVOc35Il0pMQIDAQABAoIBADdJNo7pLSkHQ8+q
+N3LYURVm42Z5vs/AVXvCura9sAz4SX7pIPxtrzG7LiZD9GPPWR94mDtQ63fHg71p
+A2b9sRejYUtaMGx+3P3DbEQX9U+CKUltNbnkGNJAIokbnV7BhFjLmMHznTRKcXuD
+NbPoNfvAyRSEQ9/1HowzVnkgzVkQbc6At8XiHjfMaT4QCQbzE3LR1kIlnKnKR6JO
+NSDwrQfrIAFPZwmWFnqAndtx9vFgcCQS/CgbYfH7YU4NKQk9eQ3lCVjV4iKJJio2
+ZlQcF0I33rsEFZX0BGzOMw6e43Djrlqiw6kCFsRyzPxw5LebsYwQMCCHTC5szOkM
+E+obT9ECgYEA+ibG4SeXadxYReIPj0L8oahYwRfs1nKP5DNBPMrjSW6DUmGm0ddv
+G8jJ2FhGATTbA2/YIzyjrBXX2U6DcfOYy7hvsEe6kZKOSJHKVrZ2IblikBJybZEY
+K0I0F+Y+9w7DkGD24T0X227WY+dXy9p5bP3XnikJQ2MJ20xnPX3KRk0CgYEA5uXe
+2GG70fsJ4hPCnRGXDCS5cEZcCwb/qqytW1WGhcC9R5IHJ9WYkeTb7QdTtjsNmaJl
+zurPhYuBtdDuarTIWwayv4BobQUxb1J6GRiJKx0yndvZhmoNECPqfoGOM68JVmC/
+8jbTEsfW3e2EDHxL19qW2CRxLGR2tyn6ZacrKHUCgYAzgIpPzuvwoqoV8T4M29jR
+m6xyTO+5Eysm65qR3p++/Z7R9kL3TyiUCtnrzfjTxMMWyQ8x6gk0o+al2fFcI7Ag
+uV9dZtc1o3vh2wpSogxeUyHE0dd3UXktZtr81K3ABe0jq6MIqqBf0EkZlobP9LIt
+S3H6IS7EDf74hJl44o4jvQKBgDN4UGmpt6WCMVzNDNfYgPQ7B39In+HxaHKSVX6D
+nR4ZrdfTbHbrvTvgaUn4FSgNF+YEdm9elm3tgDeYYF02+WaZIqVfqWeL/c4T85W+
+i20p8AuSY3X8E/diGjajCKDqxskTfhYvNHP+Sh5kgMgLuRhf6Lo7vWKo7nG8EM4y
+KoO1AoGBAJ83lusCyRGVE8GuLlFee6ofitqjVSltRC+/pENgA9Jg6iG9F9wtHG7r
+C58eQTENwUC/TRVZhlaUULejZO1usSgZOfTagsxXnN2SEwLp+k05UxyaLFqo506E
+osRChfyr8giaAYSyL4kPY3HVMJ1JHqzgALK2xYbKIeqTgGCzxZqQ
+-----END RSA PRIVATE KEY-----

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+PYCORD_TEST_MODE=1`
	`2`	`+PYCORD_BOT_TOKEN=ODc2ODk3MTgzOTAxODM1MzI1.YRqwJA.qXrCAxh-19nYzh-9s7aHgVZnW64`
	`3`	`+PYCORD_CERT_PATH=/home/nerd/Documents/git_repos/pycord/tests/pycord-cert.pem`