Skip to content

Commit

Permalink
docs(github): Documents for GitHub repository
Browse files Browse the repository at this point in the history
They make it beautiful and useful.
  • Loading branch information
5ouma committed Feb 14, 2024
1 parent 472364c commit b86fc97
Show file tree
Hide file tree
Showing 13 changed files with 356 additions and 3 deletions.
130 changes: 130 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# 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
any ways @5ouma have.
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](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](https://www.contributor-covenant.org/translations).

[https://www.contributor-covenant.org/faq]: https://www.contributor-covenant.org/faq
38 changes: 38 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing Guide<!-- omit in toc -->

> [!NOTE]
> You must follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
I happily welcome your contributions!
Before you contribute,
I would recommend reading this guideline for a better development experience.

<br />

- [🔠 Branch Prefix](#-branch-prefix)

<br />

## 🔠 Branch Prefix

You should follow these branch name rules
because [Pull Request Labeler] automatically adds labels to your Pull Requests.
<br />
For the details of each label, please see [Labels](https://github.com/5ouma/opml-generator/labels).

[Pull Request Labeler]: https://github.com/actions/labeler

| Label | Branch Prefix RegEx |
| :-----------------: | :----------------------------------: |
| Type: Feature | `^feat(ure)?-` |
| Type: Bug | `^fix-` |
| Type: Security | `^sec(urity)?-` |
| Type: Documentation | `^doc(ument)?s?-` |
| Type: Refactoring | `^refactor(ing)?-` |
| Type: Testing | `^test(ing\|s)?-` |
| Type: Maintenance | `^maintenance-` , `^maintain(ing)?-` |
| Type: CI | `^ci-` |
| Type: Dependencies | `^dep(endency\|endencies\|s)?-` |
| Type: Meta | `^meta-` |

> Labels were generated with [@azu / github-label-setup](https://github.com/azu/github-label-setup)
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: 🎉 Feature Request
description: Request a new feature or enhancement to an existing feature
labels: ["Type: Feature"]
body:
- type: textarea
id: feature-description
attributes:
label: ✏️ Describe the feature
description: A clear and concise description
placeholder: |
- I want a feature to...
- This behavior should be...
validations:
required: true

- type: checkboxes
id: checks
attributes:
label: ✔︎ Confirm these checks
description: Make sure you reviewed below
options:
- label: I searched the GitHub [Issues](https://github.com/5ouma/opml-generator/issues) or [Discussions](https://github.com/5ouma/opml-generator/discussions).
required: true
- label: I tried with the latest version.
required: false
- label: I agree to follow the [Code of Conduct](https://github.com/5ouma/opml-generator/blob/main/.github/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: additional-info
attributes:
label: 🗒️ Additional Information
description: Anything else you want to add
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 🧰 Bug Report
description: Something doesn't work
labels: ["Type: Bug"]
body:
- type: textarea
id: bug-description
attributes:
label: ✏️ Describe the Bug
description: A clear and concise description
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: 🏭 How to Reproduce the Bug
description: Steps to reproduce the behavior
validations:
required: true

- type: checkboxes
id: checks
attributes:
label: ✔︎ Confirm these checks
description: Make sure you reviewed below
options:
- label: I searched the GitHub [Issues](https://github.com/5ouma/opml-generator/issues) or [Discussions](https://github.com/5ouma/opml-generator/discussions).
required: true
- label: I tried with the latest version.
required: false
- label: I agree to follow the [Code of Conduct](https://github.com/5ouma/opml-generator/blob/main/.github/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: additional-info
attributes:
label: 🗒️ Additional Information
description: Anything else you want to add
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
blank_issues_enabled: false
contact_links:
- name: 💬 General Discussions
url: https://github.com/5ouma/opml-generator/discussions/new?category=general
about: Chat about anything and everything here

- name: 🙏 Q&A
url: https://github.com/5ouma/opml-generator/discussions/new?category=q-a
about: Ask the community for help
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- markdownlint-disable MD041 -->

**Issue:** close #

### Checklist

- [ ] This Pull Request introduces a new feature.
- [ ] This Pull Request fixes a bug.

### Description

<!--
A clear and concise description
- Why did you make this change?
- Please describe how this method is better than others.
-->

<br />

- [ ] I agree to follow the [Code of Conduct](https://github.com/5ouma/opml-generator/blob/main/.github/CODE_OF_CONDUCT.md).
8 changes: 8 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Security Policy

## 🛡️ Reporting a Vulnerability

If you find any issues of security, please report on [Security Advisories](https://github.com/5ouma/opml-generator/security/advisories/new).

> [!CAUTION]
> Please do NOT open Issues.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
20 changes: 20 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"Type: Feature":
- head-branch: ["^feat(ure)?-"]
"Type: Bug":
- head-branch: ["^fix-"]
"Type: Security":
- head-branch: ["^sec(urity)?-"]
"Type: Documentation":
- head-branch: ["^doc(ument)?s?-"]
"Type: Refactoring":
- head-branch: ["^refactor(ing)?-"]
"Type: Testing":
- head-branch: ["^test(ing|s)?-"]
"Type: Maintenance":
- head-branch: ["^maintenance-", "^maintain(ing)?-"]
"Type: CI":
- head-branch: ["^ci-"]
"Type: Dependencies":
- head-branch: ["^dep(endency|endencies|s)?-"]
"Type: Meta":
- head-branch: ["^meta-"]
30 changes: 30 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
changelog:
exclude:
labels:
- "Type: Meta"
- "Type: Question"
- "Type: Release"

categories:
- title: 🧨 Breaking Changes
labels: ["Type: Breaking Change"]
- title: 🎉 New Features
labels: ["Type: Feature"]
- title: 🧰 Bug Fixes
labels: ["Type: Bug"]
- title: 🔐 Security Fixes
labels: ["Type: Security"]
- title: 📖 Documentation Changes
labels: ["Type: Documentation"]
- title: 🧹 Refactoring
labels: ["Type: Refactoring"]
- title: 🧪 Testing
labels: ["Type: Testing"]
- title: 🔧 Maintenance
labels: ["Type: Maintenance"]
- title: 🎽 CI
labels: ["Type: CI"]
- title: ⛓️ Dependency Updates
labels: ["Type: Dependencies", "dependencies"]
- title: 🚐 Other Changes
labels: ["*"]
4 changes: 1 addition & 3 deletions renovate.json → .github/renovate.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:recommended"
]
"extends": ["config:recommended"]
}
2 changes: 2 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[default.extend-words]
ure = "ure"
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Souma

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.

0 comments on commit b86fc97

Please sign in to comment.