From 188e6cf0f8056c55359461595cc6827c5ab85483 Mon Sep 17 00:00:00 2001 From: Vyom Jain Date: Wed, 23 Feb 2022 23:14:44 +0530 Subject: [PATCH] Initial commit --- .gitattributes | 144 ++++++++++++++++++++++ .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 25 ++++ .github/ISSUE_TEMPLATE/chore.md | 17 +++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/documentation.md | 21 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++ .github/ISSUE_TEMPLATE/other.md | 17 +++ .github/PULL_REQUEST_TEMPLATE.md | 13 ++ .github/workflows/codeql-analysis.yml | 71 +++++++++++ .github/workflows/labels.yml | 21 ++++ CODE_OF_CONDUCT.md | 76 ++++++++++++ CONTRIBUTING.md | 125 +++++++++++++++++++ LICENSE | 29 +++++ README.md | 14 +++ SECURITY.md | 3 + 16 files changed, 599 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/chore.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/labels.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 SECURITY.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1023290 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,144 @@ +######################################################################## +# Generated using https://rehansaeed.com/gitattributes-best-practices/ # +######################################################################## + + + +# Line Ending Normalisation: + +* text=auto + +# Source files: + +*.pxd text diff=python +*.py text diff=python +*.py3 text diff=python +*.pyw text diff=python +*.pyx text diff=python +*.pyz text diff=python +*.ipynb text +*.ts text +*.du text + +*.go -text diff=golang + +################ +# Binary files # +################ + +# Python: +*.db binary +*.p binary +*.pkl binary +*.pickle binary +*.pyc binary +*.pyd binary +*.pyo binary + +# Graphics: +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.ico binary +*.pdf binary +*.psb binary +# SVG treated as an asset (binary) by default. +*.svg text +*.webp binary + +# Archives: +*.7z binary +*.gz binary +*.tar binary +*.tgz binary +*.zip binary + +# Documentation +*.ipynb text +*.markdown text +*.md text +*.mdwn text +*.mdown text +*.mkd text +*.mkdn text +*.mdtxt text +*.mdtext text +*.txt text +AUTHORS text +CHANGELOG text +CHANGES text +CONTRIBUTING text +COPYING text +copyright text +*COPYRIGHT* text +INSTALL text +license text +LICENSE text +NEWS text +readme text +*README* text +TODO text +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain +*.tex text diff=tex +*.adoc text +*.textile text +*.mustache text +*.csv text +*.tab text +*.tsv text +*.txt text +*.sql text + +# Force batch scripts to always use CRLF line endings so that if a repo is accessed +# in Windows via a file share from Linux, the scripts will work. +*.{cmd,[cC][mM][dD]} text eol=crlf +*.{bat,[bB][aA][tT]} text eol=crlf + +# Force bash scripts to always use LF line endings so that if a repo is accessed +# in Unix via a file share from Windows, the scripts will work. +*.sh text eol=lf + +# Executables +*.exe binary +*.pyc binary + +# Serialisation +*.json text +*.toml text +*.xml text +*.yaml text +*.yml text + +# Vim: +*.vim text eol=lf +.vimrc text eol=lf + +# RC files (like .babelrc or .eslintrc) +*.*rc text + +# Docker +Dockerfile text + +# Heroku +Procfile text + +# Text files where line endings should be preserved +*.patch -text + + +# Exclude files from exporting: +.gitattributes export-ignore +.gitignore export-ignore + +# Enable syntax highlighting for files with `.gitattributes` extensions. +*.gitattributes linguist-language=gitattributes diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..b8b5b2d --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @Vyvy-vi diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..bf1ff4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a report to help us address an error. +title: "[BUG]" +labels: "🛠 goal: fix" +assignees: "" +--- + +# Bug Report + +## Describe the bug + + + +## Expected behavior + + + +## Screenshots + + + +## Additional information + + diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md new file mode 100644 index 0000000..c010828 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/chore.md @@ -0,0 +1,17 @@ +--- +name: Chore +about: For requesting chores, such as cleaning up code. +title: "[CHORE]" +labels: "🤖 aspect: dx, đŸšĻ status: awaiting triage" +assignees: Vyvy-vi +--- + +# Chore Request + +## Describe the work + + + +## Additional information + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..f4efc75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,21 @@ +--- +name: Documentation +about: Request an update to invalid/outdated documentation. +title: "[DOC] " +labels: "📄 aspect: text" +assignees: '' +--- + +# Incorrect Documentation + +## Describe the error + + + +## Expected information + + + +## Additional information + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2c9c63b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEAT]" +labels: "✨ goal: improvement, ⭐ goal: addition" +assignees: "" +--- + +# Feature Request + +## Is your feature request related to a problem? Please describe: + + + +## Describe the solution you'd like + + + +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 0000000..d07c31c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,17 @@ +--- +name: Other +about: Use this for any other issues. PLEASE do not create blank issues. +title: "[OTHER]" +labels: "đŸšĻ status: awaiting triage" +assignees: Vyvy-vi +--- + +# Other Issue + +## Describe the issue + + + +## Additional information + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b41f3b4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +# Pull Request + + + +## Description: + + + +## Related Issue: + + + +Closes #XXXXX diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..9468783 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,71 @@ +# 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: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '40 17 * * 4' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python', '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/labels.yml b/.github/workflows/labels.yml new file mode 100644 index 0000000..7aecb34 --- /dev/null +++ b/.github/workflows/labels.yml @@ -0,0 +1,21 @@ +name: Import open source standard labels + +on: + workflow_dispatch: + schedule: + - cron: '40 17 * * 4' + +jobs: + labels: + + runs-on: ubuntu-latest + + steps: + - uses: actions/setup-node@v2 + with: + node-version: '14' + - uses: EddieHubCommunity/gh-action-open-source-labels@v0.2.2 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + owner-name: ${{ github.repository_owner }} + repository-name: ${{ github.event.repository.name }} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6e1e10f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, 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. + +## 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 which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +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. + +Project maintainers 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, 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 e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at vyom.j@protonmail.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. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..613b5d2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,125 @@ +# Contributing +Thank you for showing interest in this project! We appreciate and encourage any and all contributions to the project. However, do keep in mind that it takes some time to get responses on issues and reviews on PRs. Before contributing, have a look at the [CODE of CONDUCT](./CODE_OF_CONDUCT.md) and try to comply with those guidelines. + +If you are new to contributing to projects on GitHub, this project follows a certain pattern of development and contributing - [github flow](https://docs.github.com/en/github/getting-started-with-github/github-flow). You could learn more about how to use Github on [Github Labs](https://lab.github.com/) and through the [Github docs](https://docs.github.com/en/github/getting-started-with-github/) + +Please ensure all pull requests and contributions comply with the [Developer Certificate of Origin](https://developercertificate.org/). + +## Setting up the project +First, [fork this repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) to your own account. Then use `git clone ` to clone your forked repository down to your local machine (remember to get the URL for _your_ repository - the fork, not the original repository). +Use `git remote add upstream ` to add the original repository as the upstream (this is helpful for keeping your fork up-to-date). + +## Feedback, Bug Reports, Issues - How to open issues? +If you have any feedback, bug reports, feature request or ideas, feel free to [open an issue](https://docs.github.com/en/github/managing-your-work-on-github/creating-an-issue) on the project's repository. We love issues! ;D +Please try not to duplicate issues and always try to give enough context in the issues that you open. +You could use some of the issues templates to make better structured issues with relevant labels. + +## Claiming an Issue +All of the issues on this repo are open to contributors! If you see an open issue you would like to work on, please comment on the issue so that you may get assigned to it. + +> NOTE: Assigned issues that have not had any activity in 2 weeks will be unassigned. + +If an issue is already assigned, please look for another issue to contribute to, or open an issue that you could work on and adds value to the project. We use labels to help categorise issues: +- `good first issue` - These issues require minimal familiarity with our codebase. Please reserve these for first-time contributors. +- `help wanted` - These issues are open to any contributors. +- `staff only` - These issues are locked to project maintainers/collaborators. Pull requests on these issues will not be accepted from outside contributors. + +## Working on your issue +This project follows a certain development and contribution pattern([github-flow](https://docs.github.com/en/github/getting-started-with-github/github-flow)). If you have any confusion at any step in the process, refer to the [Github docs](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). Feel free to comment on your assigned issue if you have any questions, doubts or need any help. (Do note that it might take some time to get help on the issues. It is highly suggested that you ask for help on [EddieHub's Everyone Helps Everyone forum](https://github.com/EddieHubCommunity/support/discussions/categories/q-a) or [freeCodeCamp's forum](https://forum.freecodecamp.org/) if you would prefer a quicker help response) + + +### Syncing your fork with the project +Before starting any work, it is highly recommended that you ensure that your forked version of the repo is up to date. If you set the upstream as mentioned in [Setting Up The Project](#setting-up-the-project), run these commands in your terminal (with the terminal pointed at the root directory of your local files): + +- Switch to the `main` branch: + ```rb + git checkout main + ``` +- Get the current state of the original repo, without pulling down the changes to your local machine: + ```css + git fetch upstream + ``` +- Reset the state of your local files to match the current state of the original repo: + ```rb + git reset --hard upstream/main + ``` +- Force the changes to your forked repo on github (thus making it match the original): + ```css + git push -f + ``` +> NOTE: Before you do the above, keep in mind that you will lose any changes you are currently working on. Do this with care. + +**If you are working on small changes directly on Github's UI**, you could also consider [using the `Fetch Upstream` button on Github's UI](https://twitter.com/i/status/1390382527588798477) + +### Creating a new branch +Before making code changes, it would be best if you create a new branch and make changes in that branch. It's always a good idea to avoid committing changes directly to your `main` branch - this keeps it clean and avoids errors when updating (above). +You could use this command to create and switch to a new branch - +```rb +git checkout -b +``` +(Alternatively, you could also make a branch on github's UI and use `git fetch` and `git checkout ` to switch to the created branch) + +Branch names should follow a convention of `type/issue/description` where: + +- `type` is the nature of the changes (eg. `feat` for a new feature, or `docs` for documentation update). This should match the [scope of the related issue](https://www.conventionalcommits.org/en/v1.0.0/#summary). +- `issue` is the number for the related issue you're addressing. +- `description` is a brief description of your changes, such as update-contribs for updating the contributing guidelines. + +Example - `docs/3/update=contribs`, when working on docs to update contributors for issue #3 + +After this, you could start working on your code :D + +### Commit Message Guidelines +Now you are free to work on your code! When you are satisfied with your changes, you can commit them with `git commit -s -m "message"`, where: + +- `-s` flag signs the commit, to verify the connection with your GitHub account. +- `-m` flag sets up the commit message. +- `message` is the commit message: a brief (50 character max) message describing what the commit changes. + +While writing the commit message, please try to be brief (if you want to add more context, you can add a description by adding another `-m "some description"` tag to the command) and try to write messages in present tense (like `docs: add link to coc`, instead of `docs: added link to coc`) + +We prefer to follow a certain commit message styling format in order to make the commits easily readable by people as well as automation. You could refer to [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) for more information about the format. + + +All commit messages should follow this format- `(optional scope): ` +(The scope can be skipped, in order to make the commit message more succint) +Examples- +``` +docs: update project links +feat: set up project +feat(deploy): deployment config +fix: fix website crash bug +``` +**Type** - The type could be one of the following: +- `fix`: bug patches, typo and lint corrections +- `feat`: introduce new features to the codebase +- `docs`: for documentation and README/CONTRIBUTING changes +- `refactor`: code change that refactors the code +- `chore`: project config, maintainance + +## Submitting a Pull Request +Once you have all of your changes made and committed, you can push them to your forked repository! Use `git push -u origin `, where: + +- `-u` tells `git` to set the upstream (see below) +- `origin` tells `git` to push to your fork +- `branchname` tells `git` to push to a branch - this MUST match the name of the branch you created locally. + +> NOTE: By setting the upstream, any subsequent push commands can be done with `git push`, and it will be pushed to the same branch. + +Now you can [open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)! You should see a quick option to do so appear at the top of your repository on GitHub. Click the "`Pull Request`" button to have GitHub automatically set up the pull request. + +First, change the title of the pull request to match your branch name (following the conventions above!). Then, follow the instructions in the preset Pull Request template (make sure to complete any steps listed!). + +Congratulations! You've submitted your first pull request! It will be reviewed as quickly as possible, so keep an eye out for comments, approvals, or requested changes. + +## Contributing in other ways +If you aren't comfortable with the codebase, or would like to contribute in other ways, we have options for that! +We like and appreciate good contributions of any kind! + +- Documentation Updates: You are always welcome to update our documentation (like this file). If you see any typos or anything that can be clarified, go on ahead and open an issue and a Pull Request! +- Feature Requests: If you have ideas for new features or improvements, feel free to open an issue! +- Arts/graphics: If you would like to make artistic contributions to the project, feel free to open an issue or contact a maintainer regarding this. We like good graphics for repository banners, or graphics that can be featured in the application. +- Bug Reports: We rely on our users to help identify bugs - if you see something wrong, please let us know with an issue! +- Dropping reviews: If you want, you could also contribute by reviewing pull requests. (If you aren't familiar with the codebase, you could still drop reviews on documentation updates) +- Legal Advice: If you are someone with legal knowledge/experience, you could contribute to the project by maybe going through the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md) and Privacy or Usage Policies. Help in this area is really really appreciated. + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7d3b6c5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2021, Vyom Jain +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ad4fd6 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Project Name + +Project Description + +## Live Version + +This page is not yet deployed. + + +## Feedback, Bugs, and Contributions + +If you have feedback or a bug report, you can create a GitHub issue or [contact me directly](http://chat.vyvy-vi.ninja). + +If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and I will review it as soon as I am able! diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..c1a39e9 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +Please DO not create GitHub issues for security issues. Instead, report responsibly by emailing `vyom.j@pm.me` or dm-ing `Vyvy-vi#5040` on Discord.