From 58a0d257432ce0ff93290897b4639213ad487868 Mon Sep 17 00:00:00 2001 From: Sat Naing Date: Mon, 14 Oct 2024 18:31:08 +0700 Subject: [PATCH] chore: format .github markdown files with Prettier (#400) --- .github/CODE_OF_CONDUCT.md | 32 ++++++++----------- .github/CONTRIBUTING.md | 3 +- .../\342\234\250-feature-request.md" | 3 +- .../\360\237\220\236-bug-report.md" | 4 +-- ...\237\223\235-documentation-improvement.md" | 3 +- 5 files changed, 19 insertions(+), 26 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 9118c2771..03fae148c 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. 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, +- 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 +- 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 +- 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 +- 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 +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -59,8 +59,7 @@ 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 -satnaingdev@gmail.com. +reported to the community leaders responsible for enforcement at [satnaingdev@gmail.com](satnaingdev@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 @@ -106,7 +105,7 @@ 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 +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 @@ -115,14 +114,11 @@ 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. +version 2.0, available at [this link](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. +For answers to common questions about this code of conduct, see the [FAQ](https://www.contributor-covenant.org/faq). [Translations](https://www.contributor-covenant.org/translations) are also available. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9f37d1e6d..dc8cfa08d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thank you for your interest in contributing to **AstroPaper**! We appreciate eve ## Types of Contributions -There are several ways to contribute to **AstroPaper**, and every contribution counts_ whether it's a PR for a major feature or a small fix. +There are several ways to contribute to **AstroPaper**, and every contribution counts\_ whether it's a PR for a major feature or a small fix. You can also contribute by leaving review comments on PRs, adding ideas to existing GitHub Issues and Discussions, or helping others by answering questions in GitHub Discussions. @@ -53,4 +53,3 @@ Since AstroPaper doesn’t currently have automated testing, it’s especially u ## Starting a Discussion If you’re unsure whether your issue warrants a fix or if you just want to share ideas and get feedback, feel free to [start a GitHub discussion](https://github.com/satnaing/astro-paper/discussions/new/choose). It’s a great way to engage with the community. - diff --git "a/.github/ISSUE_TEMPLATE/\342\234\250-feature-request.md" "b/.github/ISSUE_TEMPLATE/\342\234\250-feature-request.md" index d875ccb76..6d1d669df 100644 --- "a/.github/ISSUE_TEMPLATE/\342\234\250-feature-request.md" +++ "b/.github/ISSUE_TEMPLATE/\342\234\250-feature-request.md" @@ -3,8 +3,7 @@ name: "✨ Feature Request" about: Suggest an idea for improving AstroPaper title: "[Feature Request]: " labels: enhancement -assignees: '' - +assignees: "" --- **Is your feature request related to a problem? Please describe.** diff --git "a/.github/ISSUE_TEMPLATE/\360\237\220\236-bug-report.md" "b/.github/ISSUE_TEMPLATE/\360\237\220\236-bug-report.md" index 783dbfc31..c949bdd88 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\220\236-bug-report.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\220\236-bug-report.md" @@ -3,8 +3,7 @@ name: "\U0001F41E Bug report" about: Report a bug or unexpected behavior in AstroPaper title: "[BUG]: " labels: bug -assignees: '' - +assignees: "" --- **Describe the bug** @@ -12,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' diff --git "a/.github/ISSUE_TEMPLATE/\360\237\223\235-documentation-improvement.md" "b/.github/ISSUE_TEMPLATE/\360\237\223\235-documentation-improvement.md" index 0f3b2244b..81cdc7ade 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\223\235-documentation-improvement.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\223\235-documentation-improvement.md" @@ -3,8 +3,7 @@ name: "\U0001F4DD Documentation Improvement" about: Propose updates or improvements to the documentation/blog posts title: "[Docs]: " labels: documentation -assignees: '' - +assignees: "" --- **Describe the Issue**