chore: contribution improvements (#71)

* add questions to Issues template * update discord link * unify prettier * add code of conduct * update contribution guide link * add gitpod page setup * add contributing.md file * add dev guide * improve wording
2023-12-03 15:56:15 +03:00
parent 4b69867d6b
commit fcc41c9f1f
14 changed files with 208 additions and 68 deletions
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions
+    url: https://dub.sh/ciodiscord
+    about: Have a question? Join our vibrant community on Discord!
@@ -1,4 +1,4 @@
-name: "Apply issue labels to PR"
+name: 'Apply issue labels to PR'

 on:
  pull_request_target:
@@ -1,23 +1,22 @@
-name: "Assign issues with .take"
+name: 'Assign issues with .take'

 on:
-    issue_comment:
-        types:
-            - created
-            - edited
+  issue_comment:
+    types:
+      - created
+      - edited
 jobs:
-    take-issue:
-        name: Disable take issue
-        runs-on: ubuntu-latest
-        timeout-minutes: 10
-        steps:
-            -   name: Disable take an issue
-                uses: bdougie/[email protected]
-                with:
-                    message: Thanks for taking this issue! Let us know if you have any questions!
-                    trigger: .take
-                    issueCurrentlyAssignedMessage: Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor.
-                    token: ${{ secrets.GITHUB_TOKEN }}
-                    blockingLabels: 👀 needs triage,blocked,core team work,needs design,duplicate
-                    blockingLabelsMessage: The issue you are trying to assign yourself is blocked by the label on the issue. 
-            
+  take-issue:
+    name: Disable take issue
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Disable take an issue
+        uses: bdougie/[email protected]
+        with:
+          message: Thanks for taking this issue! Let us know if you have any questions!
+          trigger: .take
+          issueCurrentlyAssignedMessage: Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor.
+          token: ${{ secrets.GITHUB_TOKEN }}
+          blockingLabels: 👀 needs triage,blocked,core team work,needs design,duplicate
+          blockingLabelsMessage: The issue you are trying to assign yourself is blocked by the label on the issue.
@@ -1,23 +1,23 @@
 name: Automatic Comment

 on:
-    issues:
-        types: [opened]
+  issues:
+    types: [opened]
 permissions:
-    contents: read
+  contents: read

 jobs:
-    comment:
-        permissions:
-            issues: write
-            pull-requests: write
-        name: Comment
-        runs-on: ubuntu-latest
-        steps:
-            -   name: Automatic Comment
-                uses: peter-evans/create-or-update-comment@v2
-                with:
-                    issue-number: ${{ github.event.issue.number }}
-                    body: |
-                        Thanks for the issue, our team will look into it as soon as possible. If you would like to work on this issue, please wait for us to decide if it's ready. To claim an issue that does not have the "needs triage" label, please leave a comment that says ".take". If you have any questions, please reach out to us on [Discord](https://discord.gg/KJUb2AwM) or follow up on the issue itself.
-                        For full info on how to contribute, please check out our [contributors guide](../contributor guide)
+  comment:
+    permissions:
+      issues: write
+      pull-requests: write
+    name: Comment
+    runs-on: ubuntu-latest
+    steps:
+      - name: Automatic Comment
+        uses: peter-evans/create-or-update-comment@v2
+        with:
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            Thanks for the issue, our team will look into it as soon as possible. If you would like to work on this issue, please wait for us to decide if it's ready. To claim an issue that does not have the "needs triage" label, please leave a comment that says ".take". If you have any questions, please reach out to us on [Discord](https://discord.gg/KJUb2AwM) or follow up on the issue itself.
+            For full info on how to contribute, please check out our [contributors guide](https://docs.classroomio.com/contributorguides/devs)
@@ -1,4 +1,4 @@
-name: "Check PR"
+name: 'Check PR'

 on:
  pull_request_target:
@@ -1,15 +1,14 @@
 {
-  "endOfLine": "lf",
-  "printWidth": 90,
-  "trailingComma": "all",
-  "semi": true,
-  "singleQuote": false,
-  "jsxSingleQuote": true,
-  "bracketSpacing": true,
-  "bracketSameLine": true,
-  "singleAttributePerLine": true,
-  "tabWidth": 2,
-  "useTabs": true,
-  "plugins": ["prettier-plugin-tailwindcss","prettier-plugin-svelte"],
-  	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+  "useTabs": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "overrides": [
+    {
+      "files": ["*.svelte"],
+      "options": {
+        "svelteBracketNewLine": true
+      }
+    }
+  ]
 }
@@ -0,0 +1,69 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in ClassroomIO and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct that could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+We as project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+We have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email 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 by contacting the project team at help@classroomio.com - all complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+## Enforcement Guidelines
+
+Community managers 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 of 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, version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
@@ -0,0 +1,29 @@
+# Contributing to ClassroomIO.com
+
+First and foremost, we're absolutely thrilled that you're considering becoming a part of the community
+
+## Issue Hunters
+
+Did you stumble upon a bug? Encountered a hiccup in deployment? Perhaps you have some user feedback to share? Your quickest route to help us out is by [raising an issue](https://github.com/rotimi-best/classroomio/issues/new/choose).
+
+## Feature Architects
+
+We invite innovative minds to contribute to the evolution of ClassroomIO. If you have a compelling feature proposal that could enhance our platform, please initiate a formal issue submission and apply the "Enhancement" label. We highly value and eagerly anticipate each unique idea presented by our community. To ensure thorough understanding and effective evaluation, kindly include a detailed rationale for your proposed feature. Your insights are crucial to our continuous growth and innovation.
+
+## 🛠 Crafting Pull Requests
+
+Ready to dive into the code and make a real impact? Here's your path:
+
+1. **Fork the Repository:** Fork our repository or use [Gitpod](https://docs.classroomio.com/contributorguides/gitpod)
+
+2. **Implementation:** Code it out, test it and apply your changes.
+
+3. **Pull Request:** If you're ready to go, create a new pull request following our PR template
+
+Would you prefer a chat before you dive into a lot of work? Our [Discord server](https://dub.sh/ciodiscord) is your harbor. Share your thoughts, and we'll meet you there with open arms. We're responsive and friendly, promise!
+
+## Features
+
+If you spot a feature that isn't part of our official plan but could propel ClassroomIO forward, don't hesitate. Raise it as an enhancement issue, and let us know you're ready to take the lead. We'll be quick to respond.
+
+Together, let's craft the future of ClassroomIO, making it better, bolder, and more brilliant!
@@ -0,0 +1,14 @@
+{
+  "useTabs": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "overrides": [
+    {
+      "files": ["*.svelte"],
+      "options": {
+        "svelteBracketNewLine": true
+      }
+    }
+  ]
+}
@@ -3,10 +3,9 @@ import { client } from '$lib/utils/posthog';

 export const load = ({ request }) => {
  client.capture({
-    distinctId:
-      request.headers.get('x-forwarded-for') || new Date().getTime().toString(),
-    event: 'discord page visited',
+    distinctId: request.headers.get('x-forwarded-for') || new Date().getTime().toString(),
+    event: 'discord page visited'
  });

-  throw redirect(301, 'https://discord.gg/NJqaZNuD');
+  throw redirect(301, 'https://discord.gg/dRmxBpJw59');
 };
@@ -1,5 +1,6 @@
 {
-  "devs": "Developers Contribution Guide",
-  "design": "Design Contribution Guide",
+  "devs": "Developers Guide",
+  "gitpod": "Gitpod setup",
+  "design": "Designers Guide",
  "localstudentdashboard": "Local Student Dashboard"
 }
@@ -1,7 +1,29 @@
-import { Callout } from "nextra/components";
-
 # Developers Contribution Guide

-<Callout emoji='🚨'>
-	This page is a work in progress. Help us expand it by contributing!
-</Callout>
+First and foremost, we're absolutely thrilled that you're considering becoming a part of the community
+
+## Issue Hunters
+
+Did you stumble upon a bug? Encountered a hiccup in deployment? Perhaps you have some user feedback to share? Your quickest route to help us out is by [raising an issue](https://github.com/rotimi-best/classroomio/issues/new/choose).
+
+## Feature Architects
+
+We invite innovative minds to contribute to the evolution of ClassroomIO. If you have a compelling feature proposal that could enhance our platform, please initiate a formal issue submission and apply the "Enhancement" label. We highly value and eagerly anticipate each unique idea presented by our community. To ensure thorough understanding and effective evaluation, kindly include a detailed rationale for your proposed feature. Your insights are crucial to our continuous growth and innovation.
+
+## Pull Requests
+
+Ready to dive into the code and make a real impact? Here's your path:
+
+1. **Fork the Repository:** Fork our repository or use [Gitpod](https://docs.classroomio.com/contributorguides/gitpod)
+
+2. **Implementation:** Code it out, test it and apply your changes.
+
+3. **Pull Request:** If you're ready to go, create a new pull request following our PR template
+
+Would you prefer a chat before you dive into a lot of work? Our [Discord server](https://dub.sh/ciodiscord) is your harbor. Share your thoughts, and we'll meet you there with open arms. We're responsive and friendly, promise!
+
+## Feature Ideas
+
+If you spot a feature that isn't part of our official plan but could propel ClassroomIO forward, don't hesitate. Raise it as an enhancement issue, and let us know you're ready to take the lead. We'll be quick to respond.
+
+Together, let's craft the future of ClassroomIO, making it better, bolder, and more brilliant!
@@ -0,0 +1,5 @@
+import { Callout } from 'nextra/components';
+
+# Gitpod Setup
+
+<Callout emoji="🚨">This page is a work in progress. Help us expand it by contributing!</Callout>
@@ -1,7 +1,5 @@
-import { Callout } from "nextra/components";
+import { Callout } from 'nextra/components';

 # Local Student Dashboard

-<Callout emoji='🚨'>
-	This page is a work in progress. Help us expand it by contributing!
-</Callout>
+<Callout emoji="🚨">This page is a work in progress. Help us expand it by contributing!</Callout>