From c582e62a4d58cc602c3e4b479ea97c9b2cfa3791 Mon Sep 17 00:00:00 2001 From: hyesung oh Date: Sat, 11 Jun 2022 22:02:25 +0900 Subject: [PATCH] Replace some files at resume / apply new docs for contributing (#60) * refactor: replace resume app's kbarActions to libs directory * docs: apply pull request template * docs: apply code of conduct * docs: apply contributing guide --- .github/PULL_REQUEST_TEMPLATE.md | 3 + CODE_OF_CONDUCT.md | 128 ++++++++++++++++++ CONTRIBUTING.md | 25 ++++ .../KbarActions/KbarActions.test.ts | 0 .../KbarActions/KbarActions.ts | 0 .../KbarActions/index.test.ts | 0 .../{constants => libs}/KbarActions/index.ts | 0 apps/resume/src/pages/_app.tsx | 2 +- 8 files changed, 157 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md rename apps/resume/src/{constants => libs}/KbarActions/KbarActions.test.ts (100%) rename apps/resume/src/{constants => libs}/KbarActions/KbarActions.ts (100%) rename apps/resume/src/{constants => libs}/KbarActions/index.test.ts (100%) rename apps/resume/src/{constants => libs}/KbarActions/index.ts (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..3772a221 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,3 @@ + + +## Description diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..a5995cfd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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 +email (haesungoh414@gmail.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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..55c1e67a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Welcome to Comet-land contributing guide + +Thank you for investing your time in `Coment-land` ! + +> Read our [Code of Conduct](https://github.com/hyesungoh/comet-land/blob/main/CODE_OF_CONDUCT.md) to keep our community approachable and respectable. + +## Comet-land wants ... + +- New feature. +- Reporting or Fixing bug. +- Discussing current code. +- Append new tests. +- Update or translate documents. +- and everything what you think of Comet-land need it. + +## How to contribute + +1. Fork the repo. +2. Do what you want for Comet-land. +3. Make sure checking tests and lint. +4. Issue that pull request ! + +## License + +By contributing, you agree that your contributions will be licensed under its MIT License. diff --git a/apps/resume/src/constants/KbarActions/KbarActions.test.ts b/apps/resume/src/libs/KbarActions/KbarActions.test.ts similarity index 100% rename from apps/resume/src/constants/KbarActions/KbarActions.test.ts rename to apps/resume/src/libs/KbarActions/KbarActions.test.ts diff --git a/apps/resume/src/constants/KbarActions/KbarActions.ts b/apps/resume/src/libs/KbarActions/KbarActions.ts similarity index 100% rename from apps/resume/src/constants/KbarActions/KbarActions.ts rename to apps/resume/src/libs/KbarActions/KbarActions.ts diff --git a/apps/resume/src/constants/KbarActions/index.test.ts b/apps/resume/src/libs/KbarActions/index.test.ts similarity index 100% rename from apps/resume/src/constants/KbarActions/index.test.ts rename to apps/resume/src/libs/KbarActions/index.test.ts diff --git a/apps/resume/src/constants/KbarActions/index.ts b/apps/resume/src/libs/KbarActions/index.ts similarity index 100% rename from apps/resume/src/constants/KbarActions/index.ts rename to apps/resume/src/libs/KbarActions/index.ts diff --git a/apps/resume/src/pages/_app.tsx b/apps/resume/src/pages/_app.tsx index 67546e61..63e09086 100644 --- a/apps/resume/src/pages/_app.tsx +++ b/apps/resume/src/pages/_app.tsx @@ -8,7 +8,7 @@ import { authorName } from 'core/constants'; import { KBarProvider } from 'kbar'; import ContactButton from '../components/ContactButton'; -import generateKbarAction from '../constants/KbarActions'; +import generateKbarAction from '../libs/KbarActions'; const KbarComponent = dynamic(() => import('core/components/Kbar'), { ssr: false,