Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Awayume committed Mar 10, 2024
0 parents commit 9e67762
Show file tree
Hide file tree
Showing 24 changed files with 1,253 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Auto detect text files and perform LF normalization
* text=auto

#
# https://help.github.com/articles/dealing-with-line-endings/
#
\\# Linux start script should use lf
/gradlew text eol=lf

# These are Windows script files and should use crlf
*.bat text eol=crlf

1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Awayume
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
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
[email protected].
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.
68 changes: 68 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Contribution Guideline
Thank you for your interest in contributing.
Please check the following before contributing.
Contributions that do not follow the rules may be rejected.

## General Rules
- You should use English in this project.

## Commits
- Write concise commit messages
- Make your commits detailed. Consider splitting commits that are too large into multiple commits.

### Commit message
Commit messages must always start with the following prefix:

| prefix | description |
|:---------|:---------------------------|
| add | Add something |
| remove | Remove something |
| change | Change something |
| update | Update something |
| upgrade | Upgrade version (not libs) |
| feat | New feature |
| fix | Fix something |
| hotfix | Fix critical bugs |
| library | Add/update/remove library |
| perf | Improve performance |
| refactor | Refactoring |
| test | Add/change test codes |
| style | Fix style |
| docs | Add/change docs |
| ci | About CI/CD |
| chore | Chores |

Example:
```
add: Add something
```

Exceptions:
- Merge commits (default message)
- Revert commits (default message)
- Dependabot commits (default message)

#### WIP commits
WIP commits should only be used on working branches.
Also, all WIP commits must be rebased before submitting a PR.
<br>
Example:
```
[WIP] add: Add something
```

#### Commits related to the Issue
Include the issue number in the commit message to link the commit to the issue.
It should appear immediately after the prefix.
<br>
```
fix #0: Fix error
```

## Pull Requests
- Do not delete templates.
- Think objectively before contributing.

## Issues
- Do not use Issues to get help. You can use Forums or Discord guild.
- Think objectively before contributing.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug Report
description: Report a bug
title: "[Bug]: "
labels: unconfirmed bug
body:
- type: input
attributes:
label: Summary
description: Please give a brief summary of the report.
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce the bug
description: Please describe the steps to reproduce the bug in as much detail as possible.
validations:
required: true

- type: textarea
attributes:
label: Code to reproduce the bug
description: |
Please post the code that reproduces the bug.
Don't omit use declarations in your code.
render: rust
validations:
required: true

- type: textarea
attributes:
label: Desired result
description: What is the result of the code above if the bug does not occur?
validations:
required: true

- type: textarea
attributes:
label: Actual result
description: What are the consequences of the above code due to the bug?
validations:
required: true

- type: input
attributes:
label: Bug reproducibility
description: Calculate the reproducibility of the bug and enter it as a percentage.
validations:
required: true

- type: textarea
attributes:
label: System information
description: Write the operating system you are using, its version and architecture.
validations:
required: true

- type: dropdown
attributes:
label: tomlib4j version
description: Choose your version of tomlib4j.
options:
- 0.1.0-alpha
validations:
required: true

- type: input
attributes:
label: tomlib4j commit hash
description: If you're using an unreleased version (alpha, beta, rc, etc.), write the tomlib4j commit hash.
validations:
required: false

- type: textarea
attributes:
label: Additional information
description: Please write if you have anything else to say.
validations:
required: false

- type: checkboxes
attributes:
label: Checklist
description: This is the final confirmation of the report.
options:
- label: I follow the contribution guidelines.
required: true
- label: I confirmed that there is no similar issue.
required: true
- label: I have checked that this issue does not contain any credentials or personal informations.
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
about: Ask a question or discuss of tomlib4j.
url: https://github.com/Awayume/tomlib4j/discussions.
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Feature Request
description: Request a new feature or change for tomlib4j, or requests for this project
title: "[Request]: "
labels: unconfirmed feature request
body:
- type: input
attributes:
label: Summary
description: Please summarize your request in one sentence.
validations:
required: true

- type: dropdown
attributes:
label: The scope of the request
description: Please select what you are requesting for tomlib4j.
options:
- tomlib4j
- tomlib4j docs
- Project management
validations:
required: true

- type: textarea
attributes:
label: Request details
description: Please describe your request in as much detail as possible.
validations:
required: true

- type: textarea
attributes:
label: Reason for request
description: Please describe in as much detail as possible why you made this request.
validations:
required: true

- type: textarea
attributes:
label: Current situation
description: What problems are you currently experiencing?
validations:
required: false

- type: textarea
attributes:
label: Problem with request
description: What problems can this request cause?
validations:
required: false

- type: textarea
attributes:
label: Additional information
description: Please write if you have anything else to say.
validations:
required: false

- type: checkboxes
attributes:
label: Checklist
description: This is the final confirmation of the report.
options:
- label: I follow the contribution guidelines.
required: true
- label: I confirmed that there is no similar issue.
required: true
- label: I have checked that this issue does not contain any credentials or personal informations.
required: true
Loading

0 comments on commit 9e67762

Please sign in to comment.