Merge pull request #100 from python-discord/notion-demigration

Adds Contributing Information

5 files changed, 89 insertions, 37 deletions

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 0000000..19aa9e7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,45 @@
+name: Bug Report
+description: "Something isn't working as expected"
+labels: ["type: bug", triage]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        
+        Other developers need to be able to reproduce your bug reports to fix them,
+        so please fill the following form to the best of your abilities.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief overview of what the bug is
+      placeholder: Clicking the submit button wipes my harddrive.
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction Steps
+      description: A set of steps that an engineer can take to find and recreate this bug
+      placeholder: |
+        1. Create a new form
+        2. Submit an empty response
+        3. ...
+    validations:
+      required: true
+  - type: textarea
+    id: files
+    attributes:
+      label: Files
+      description: If you have any screenshots, log files, or other files that you believe are relevant, you can attach them here
+      validations:
+        required: false
+  - type: textarea
+    id: technical
+    attributes:
+      label: Technical Details
+      description: "If you have a technical overview of what is causing the bug please describe it here, don't worry if not"
+      validations:
+        required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 4b036ed..194ed86 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Notion task board
-    url: https://www.notion.so/pythondiscord/2c44f303ec36425da23494f606973f14?v=39e0f16a1ffe4152b3dccb9d5bce9301
-    about: Staff-only Notion task board for feature requests and bug reports.
   - name: Public GitHub Discussions
     url: https://github.com/python-discord/forms-backend/discussions
     about: GitHub Discussions from external collaborators.
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
new file mode 100644
index 0000000..5d4fe58
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,36 @@
+name: Feature Request
+description: New features, or modifications to existing ones
+labels: ["type: feature", triage]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+        
+        Developers need to be able to understand your request,
+        to properly discuss it an implement it. Please fill this
+        form to the best of your ability.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: "Describe what the feature is for, don't give justification just yet, just give the concrete description of the feature."
+      placeholder: The app needs even more routes.
+    validations:
+      required: true
+  - type: textarea
+    id: justification
+    attributes:
+      label: Justification
+      description: Describe why this feature is necessary, does it fit into one of our epics? Are there any use cases for Forms that we can see this feature being useful for?
+      placeholder: "The current number of routes isn't as high as it should be because..."
+    validations:
+      required: true
+  - type: textarea
+    id: implm
+    attributes:
+      label: Implementation
+      description: If you have any suggestions for engineers, you can leave them here
+      validations:
+        required: false
diff --git a/.github/contributing.md b/.github/contributing.md
new file mode 100644
index 0000000..6eb94a4
--- /dev/null
+++ b/.github/contributing.md
@@ -0,0 +1,5 @@
+# Contributing Guidelines
+
+The Contributing Guidelines for Python Discord projects can be found [on our website](https://pydis.com/contributing.md).
+
+You can find the setup instructions for this project in the [README](../README.md).
diff --git a/README.md b/README.md
index 59bdf17..42870d1 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,8 @@
 # Python Discord Forms API
 API for [Python Discord Forms](https://forms.pythondiscord.com) that handles Discord OAuth2 integration and form submission.
 
-## Setup
-### Prerequisites
-To start working on forms-backend, you'll need few things:
-1. Discord OAuth2 Application (from the [Discord Developers Portal](https://discord.com/developers/applications))
-2. Poetry
-3. Docker and docker-compose (optional)
-4. Running MongoDB instance (when not using Docker)
-5. Running [Snekbox](https://git.pydis.com/snekbox) instance (when not using Docker, optional)
+You can find the frontend at [python-discord/forms-frontend](https://github.com/python-discord/forms-frontend).
 
-### Running with Docker
-The easiest way to run forms-backend is using Docker (and docker-compose).
 
-#### Environment variables
-Create a `.env` file in the root with the following values inside it (each variable should be a line like `VARIABLE=value`):
-- `OAUTH2_CLIENT_ID`: Client ID of Discord OAuth2 Application (see prerequisites).
-- `OAUTH2_CLIENT_SECRET`: Client Secret of Discord OAuth2 Application (see prerequisites).
-- `ALLOWED_URL`: Allowed origin for CORS middleware.
-- `PRODUCTION`: Set to False if running on localhost. Defaults to true.
-
-#### Running
-To start using the application, simply run `docker-compose up` in the repository root. You'll be able to access the application by visiting http://localhost:8000/
-
-### Running on the host
-You can also run forms-backend manually on the host.
-
-#### Environment variables
-Create a `.env` file with the same contents as the Docker section above and the following new variables:
-- `FRONTEND_URL`: Forms frontend URL.
-- `DATABASE_URL`: MongoDB instance URI, in format `mongodb://(username):(password)@(database IP or domain):(port)`.
-- `MONGO_DB`: MongoDB database name, defaults to `pydis_forms`.
-- `SNEKBOX_URL`: Snekbox evaluation endpoint.
-
-#### Running
-Simply run: `$ uvicorn --reload --host 0.0.0.0 --debug backend:app`.
-
-Once this is running the API is accessible via http://localhost:8000/ and will reload on any changes to code.
+## Setup & Running
+The setup process for the frontend and backend is documented on [notion](https://pythondiscord.notion.site/Get-Started-30458bfb32ce4a0e9c489ea66daf0323).