8 changed files with 195 additions and 80 deletions
@ -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. |
||||
@ -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! |
||||
|
|
||||
|
--- |
||||
@ -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 |
|
||||
@ -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 |
||||
|
Before Width: | Height: | Size: 7.6 KiB |
Loading…
Reference in new issue