-
Notifications
You must be signed in to change notification settings - Fork 1
docs(github): add common policy documents #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f4c91cb
Initial plan
Copilot cec0bb7
Changes before error encountered
Copilot 92fed5c
Add CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md
Copilot 124eb01
Update SECURITY.md to reflect template repository context and improve…
Copilot 7be63b4
docs: Simplify and update SECURITY.md instructions
kimchanhyung98 242d224
docs: Remove Korean translation from Code of Conduct
kimchanhyung98 8ec5224
fix: Remove CONTRIBUTING.md guidelines file
kimchanhyung98 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| kimchanhyung98@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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Contributing to Base | ||
|
|
||
| Thank you for your interest in contributing to this project! This document provides guidelines for contributing. | ||
|
|
||
| ## 기여 가이드 (Contribution Guidelines) | ||
|
|
||
| ### How to Contribute / 기여 방법 | ||
|
|
||
| 1. **Fork the repository** / 저장소를 포크하세요 | ||
| 2. **Create a new branch** / 새 브랜치를 생성하세요 | ||
| ```bash | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
| 3. **Make your changes** / 변경사항을 작성하세요 | ||
| 4. **Commit your changes** / 변경사항을 커밋하세요 | ||
| ```bash | ||
| git commit -m "Add: your feature description" | ||
| ``` | ||
| 5. **Push to your fork** / 포크한 저장소에 푸시하세요 | ||
| ```bash | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
| 6. **Open a Pull Request** / Pull Request를 열어주세요 | ||
|
|
||
| ### Commit Message Guidelines / 커밋 메시지 가이드라인 | ||
|
|
||
| Please follow these commit message conventions: | ||
|
|
||
| - `Add:` - New features or files / 새로운 기능이나 파일 추가 | ||
| - `Fix:` - Bug fixes / 버그 수정 | ||
| - `Update:` - Updates to existing features / 기존 기능 업데이트 | ||
| - `Remove:` - Removing features or files / 기능이나 파일 제거 | ||
| - `Docs:` - Documentation changes / 문서 변경 | ||
| - `Style:` - Code style changes (formatting, etc.) / 코드 스타일 변경 | ||
| - `Refactor:` - Code refactoring / 코드 리팩토링 | ||
| - `Test:` - Adding or updating tests / 테스트 추가 또는 업데이트 | ||
| - `Chore:` - Maintenance tasks / 유지보수 작업 | ||
|
kimchanhyung98 marked this conversation as resolved.
Outdated
kimchanhyung98 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Pull Request Guidelines / Pull Request 가이드라인 | ||
|
|
||
| - Ensure your code follows the existing code style / 기존 코드 스타일을 따라주세요 | ||
| - Update documentation as needed / 필요한 경우 문서를 업데이트하세요 | ||
| - Add tests if applicable / 가능한 경우 테스트를 추가하세요 | ||
| - Make sure all tests pass / 모든 테스트가 통과하는지 확인하세요 | ||
| - Keep pull requests focused on a single feature or fix / Pull Request는 단일 기능이나 수정사항에 집중하세요 | ||
|
|
||
| ### Code Review Process / 코드 리뷰 프로세스 | ||
|
|
||
| 1. All submissions require review / 모든 제출물은 리뷰가 필요합니다 | ||
| 2. Maintainers will review your PR as soon as possible / 관리자가 가능한 빨리 PR을 리뷰합니다 | ||
| 3. Address any feedback or requested changes / 피드백이나 요청사항에 대응해주세요 | ||
| 4. Once approved, your PR will be merged / 승인되면 PR이 병합됩니다 | ||
|
|
||
| ### Reporting Issues / 이슈 보고 | ||
|
|
||
| When reporting issues, please include: | ||
|
|
||
| - A clear description of the problem / 문제에 대한 명확한 설명 | ||
| - Steps to reproduce the issue / 이슈 재현 단계 | ||
| - Expected behavior / 예상 동작 | ||
| - Actual behavior / 실제 동작 | ||
| - Your environment (OS, version, etc.) / 환경 정보 (OS, 버전 등) | ||
|
|
||
| ### Getting Help / 도움 받기 | ||
|
|
||
| If you have questions: | ||
|
|
||
| - Check existing issues and discussions / 기존 이슈와 토론을 확인하세요 | ||
| - Open a new issue for bugs / 버그는 새 이슈를 열어주세요 | ||
| - Start a discussion for questions / 질문은 토론을 시작하세요 | ||
|
|
||
| ## Code of Conduct / 행동 강령 | ||
|
|
||
| Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
|
||
| 이 프로젝트는 [행동 강령](CODE_OF_CONDUCT.md)과 함께 배포됩니다. 이 프로젝트에 참여함으로써 귀하는 해당 조건을 준수하는 데 동의합니다. | ||
|
|
||
| ## License / 라이선스 | ||
|
|
||
| By contributing, you agree that your contributions will be licensed under the MIT License. | ||
|
|
||
| 기여함으로써 귀하의 기여가 MIT 라이선스에 따라 라이선스됨에 동의합니다. | ||
|
|
||
| --- | ||
|
|
||
| ## References / 참고 문헌 | ||
|
|
||
| This contribution guide follows best practices from: | ||
| - [GitHub's Guide to Contributing](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions) | ||
| - [Open Source Guides](https://opensource.guide/how-to-contribute/) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 kimchanhyung98 | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Security Policy / 보안 정책 | ||
|
|
||
| ## Supported Versions / 지원 버전 | ||
|
|
||
| 프로젝트의 어떤 버전이 현재 보안 업데이트를 지원하는지 알려주세요. | ||
|
|
||
| | Version | Supported | | ||
| |---------|--------------------| | ||
| | latest | :white_check_mark: | | ||
| | < 1.0 | :x: | | ||
|
|
||
| ## Reporting a Vulnerability / 취약점 보고 | ||
|
|
||
| 취약점을 보고하는 방법을 안내해주세요. | ||
| 보고할 위치, 보고된 취약점에 대한 업데이트 빈도, 취약점 승인 또는 거부 시 예상되는 사항 등을 알려주세요. | ||
|
|
||
| ### How to Report / 보고 방법 | ||
|
|
||
| * 공개 GitHub 이슈를 통해 보안 취약점을 보고하지 마세요. | ||
| * 대신 다음 방법 중 하나를 사용하세요: | ||
|
|
||
| 1. GitHub Security Advisories | ||
| - 저장소의 Security 탭으로 이동 | ||
| - "Report a vulnerability" 클릭 | ||
| - 세부 정보와 함께 양식 작성 | ||
|
|
||
| 2. Direct Email | ||
| - 저장소 관리자에게 세부 정보 전송 | ||
| - 제목에 "SECURITY" 포함 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.