Skip to content
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

wf: organize project files and integrate linting jobs #249

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .config/vale/styles/.gitkeep
Empty file.
10 changes: 10 additions & 0 deletions .github/CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Our Pledge

<!--alex disable sex sexual-->

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, caste, color, 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.
Expand All @@ -10,6 +12,8 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div

Examples of behavior that contributes to a positive environment for our community include:

<!--alex disable just-->

- Demonstrating empathy and kindness toward other people.
- Being respectful of differing opinions, viewpoints, and experiences.
- Giving and gracefully accepting constructive feedback.
Expand All @@ -18,6 +22,8 @@ Examples of behavior that contributes to a positive environment for our communit

Examples of unacceptable behavior include:

<!--alex disable attacks-->

- 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.
Expand All @@ -28,6 +34,8 @@ Examples of unacceptable behavior include:

Project maintainers 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.

<!--alex disable reject-->

Project maintainers 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
Expand All @@ -40,6 +48,8 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor

All project maintainers are obligated to respect the privacy and security of the reporter of any incident.

<!--alex disable faith-->

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution
Expand Down
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ etc/* @kurosakishigure
deny.toml @kurosakishigure
sgconfig.yml @kurosakishigure
changelogithub.config.json @kurosakishigure
.prettierrc.toml @kurosakishigure
.yamllint.yml @kurosakishigure
.markdownlint.yml @kurosakishigure
.prettierignore @kurosakishigure
.vale.ini @kurosakishigure

# Dependencies
rust-toolchain.toml @kurosakishigure
Expand Down
24 changes: 17 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Contributing to Katharsis

<!--vale Google.Exclamation = off-->

Thank you so much for contributing to Katharsis! We truly appreciate every single contribution you make.

<!--vale Google.Exclamation = on-->

> [!NOTE]
>
> - Before jumping into a PR be sure to search [existing PRs](https://github.com/kurosakishigure/katharsis/pulls) or [issues](https://github.com/kurosakishigure/katharsis/issues) for an open or closed item that relates to your submission.
> - Before performing any actions, such as submitting a PR or opening an issue, follow the relevant templates and process guidelines.
> - If you use code from other open-source projects, place the corresponding LICENSE file in the [LICENSES](../LICENSES) folder and add the relevant information to the [NOTICE](../LICENSES/NOTICE) file.
Expand All @@ -13,20 +18,22 @@ Thank you so much for contributing to Katharsis! We truly appreciate every singl

Here are some guidelines to maintain a consistent style and voice across the docs:

<!--alex disable easy-->

- Write clear, concise sentences. Avoid tangents.
- If you find yourself using a lot of commas, consider breaking the sentence into multiple sentences or use a list.
- Swap out complex words for simpler ones. For example, use instead of utilize.
- If you find yourself using a lot of commas, consider breaking the sentence into multiple sentences or use a list.
- Swap out complex words for simpler ones. For example, use instead of utilize.
- Be mindful with the word this. It can be ambiguous and confusing, don't be afraid to repeat the subject of the sentence if unclear.
- For example, Katharsis uses Rust instead of Katharsis uses this.
- For example, Katharsis uses Rust instead of Katharsis uses this.
- Use an active voice instead of passive. An active sentence is easier to read.
- For example, Katharsis uses Rust instead of Rust is used by Katharsis. If you find yourself using words like was and by you may be using a passive voice.
- For example, Katharsis uses Rust instead of Rust is used by Katharsis. If you find yourself using words like was and by you may be using a passive voice.
- Avoid using words like easy, quick, simple, just, etc. This is subjective and can be discouraging to users.
- Avoid negative words like don't, can't, won't, etc. This can be discouraging to readers.
- Write in second person (you/your). This is more personal and engaging.
- Use gender-neutral language. Use developers, users, or readers, when referring to the audience.
- If adding code examples, ensure they are properly formatted and working.

> If you'd like to dive deeper into technical writing, check out the [Google Technical Writing Course](https://developers.google.com/tech-writing/overview).
> If you'd like to explore further into technical writing, check out the [Google Technical Writing Course](https://developers.google.com/tech-writing/overview).

### Code

Expand Down Expand Up @@ -62,7 +69,7 @@ All pull request submissions to this project must comply with the [DCO](DCO).
### Naming

| Label | Prefix |
|---------------|--------|
| ------------- | ------ |
| documentation | docs |
| enhancement | feat |
| bug | fix |
Expand All @@ -74,7 +81,7 @@ All pull request submissions to this project must comply with the [DCO](DCO).
| dev | dev |

| Type | Format | Example |
|--------|--------------------|------------------------------------|
| ------ | ------------------ | ---------------------------------- |
| Branch | `PREFIX/NAME` | `wf/remove_close_jobs` |
| Commit | `PREFIX: DESCRIBE` | `wf: remove jobs related to close` |
| PR | `PREFIX: TITLE` | `wf: remove jobs related to close` |
Expand All @@ -83,6 +90,8 @@ All pull request submissions to this project must comply with the [DCO](DCO).

### Local Development

<!--markdownlint-disable MD031-->

1. Clone the Katharsis repository (download only recent commits for faster clone):
```bash
gh repo clone kurosakishigure/katharsis -- --filter=blob:none --branch canary --single-branch
Expand Down Expand Up @@ -124,5 +133,6 @@ All pull request submissions to this project must comply with the [DCO](DCO).
As we cannot verify the origin of contributors' code, please submit an [issue](https://github.com/kurosakishigure/katharsis/issues) if our project violates any applicable licenses.

> [!NOTE]
>
> - To request additional License information, please [Report a docs issue](https://github.com/kurosakishigure/katharsis/issues/new?assignees=&labels=&projects=&template=docs.yml&title=docs%3A+).
> - To request the removal of specific code, please [Report an issue](https://github.com/kurosakishigure/katharsis/issues/new?assignees=&labels=&projects=&template=fix.yml&title=fix%3A+).
17 changes: 2 additions & 15 deletions .github/DISCUSSION_TEMPLATE/ideas.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,9 @@ body:
attributes:
label: Goals
description: Short list of what the feature request aims to address?
value: |
1.
2.
3.
value: 1. Feature description
validations:
required: true
- type: textarea
attributes:
label: Non-Goals
description: Short list of what the feature request _does not_ aim to address?
value: |
1.
2.
3.
validations:
required: false
- type: textarea
attributes:
label: Background
Expand All @@ -30,4 +17,4 @@ body:
label: Proposal
description: How should this feature be implemented? Are you interested in contributing?
validations:
required: true
required: false
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: 'dev: '
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our dev kit!
value: Thank you for helping us update our dev kit!
- type: textarea
id: dev_kit_description
attributes:
Expand Down
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ title: 'docs: '
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our docs!
value: Thank you for helping us update our docs!
- type: input
id: page_link
attributes:
label: Page Link
description: The URL of the page where the document is located.
placeholder: ex. https://example.com/docs/USE.md
placeholder: for example, https://example.com/docs/USE.md
- type: textarea
id: documentation_issue
attributes:
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/ex.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: 'ex: '
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our example!
value: Thank you for helping us update our example!
- type: textarea
id: example_description
attributes:
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: 'feat: '
body:
- type: markdown
attributes:
value: |
Thanks for contributing to Katharsis, please go ahead and describe your proposal!
value: Thanks for contributing to Katharsis, please go ahead and describe your proposal!
- type: textarea
id: feature_description
attributes:
Expand Down
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/fix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,28 @@ title: 'fix: '
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
value: Thanks for taking the time to fill out this bug report!
- type: input
id: katharsis_version
attributes:
label: Katharsis Version
description: What is the version number of your Katharsis?
placeholder: ex. 1.0.0
placeholder: for example, 1.0.0
validations:
required: true
- type: input
id: system_version
attributes:
label: System Version
description: What is your system version?
placeholder: ex. macOS 15.1.1
placeholder: for example, macOS 15.1.1
validations:
required: true
- type: textarea
id: to_reproduce
attributes:
label: To Reproduce
description: A step-by-step description of how to reproduce the issue. Contributors are encouraged to include a link-based reproduction if possible.
description: A step-by-step description of how to reproduce the issue. If possible, we prefer reproduction via links.
validations:
required: true
- type: textarea
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: 'test: '
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our test!
value: Thank you for helping us update our test!
- type: textarea
id: test_description
attributes:
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/wf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: 'wf: '
body:
- type: markdown
attributes:
value: |
Thank you for helping us update our workflow!
value: Thank you for helping us update our workflow!
- type: textarea
id: workflow_description
attributes:
Expand Down
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--markdownlint-disable MD041-->

<!-- Thanks for opening a PR! Your contribution is much appreciated -->

### Summary of Changes
Expand Down
2 changes: 2 additions & 0 deletions .github/comments/cannot-recreate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--markdownlint-disable MD041-->

We are unable to recreate this issue.

Please provide more detailed reproduction steps or improve the repository linked for reproduction to help us recreate the issue.
2 changes: 2 additions & 0 deletions .github/comments/good-first-issue.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--markdownlint-disable MD041-->

The issue was marked with the `good first issue` label by a maintainer.

This means that it is a good candidate for someone interested in contributing to the project, but does not know where to start.
Expand Down
2 changes: 2 additions & 0 deletions .github/comments/issue-duplicate.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<!--markdownlint-disable MD041-->

Same issue already exists. Please visit the [Issues](https://github.com/kurosakishigure/katharsis/issues) page to search for related issues, including both open and closed ones.
2 changes: 2 additions & 0 deletions .github/comments/need-improvement.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--markdownlint-disable MD041-->

This PR needs improvement.

If the PR template was not followed, please update your description based on [PULL_REQUEST_TEMPLATE.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/PULL_REQUEST_TEMPLATE.md?plain=1).
Expand Down
2 changes: 2 additions & 0 deletions .github/comments/pr-duplicate.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<!--markdownlint-disable MD041-->

Same PR already exists. Please visit the [Pull requests](https://github.com/kurosakishigure/katharsis/pulls) page to search for related PRs, including both open and closed ones.
2 changes: 2 additions & 0 deletions .github/comments/unclear.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<!--markdownlint-disable MD041-->

The description of the issue is unclear. Please complete your issue description based on the provided template.
11 changes: 3 additions & 8 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
newIssueWelcomeComment: >
Thanks for opening your first issue here!

newPRWelcomeComment: >
Thanks for opening this pull request!

firstPRMergeComment: >
Congrats on merging your first pull request!
newIssueWelcomeComment: Thanks for opening your first issue here!
newPRWelcomeComment: Thanks for opening this pull request!
firstPRMergeComment: Congrats on merging your first pull request!
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ updates:
schedule:
interval: daily
open-pull-requests-limit: 10
labels: [ ]
labels: []
commit-message:
prefix: 'dep'
- package-ecosystem: github-actions
directory: '/'
schedule:
interval: daily
labels: [ ]
labels: []
commit-message:
prefix: 'act'
17 changes: 17 additions & 0 deletions .github/workflows/action-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Action Lint
on:
pull_request:
paths:
- '.github/workflows/*.yml'
jobs:
actionlint:
runs-on: ubuntu-latest
name: actionlint
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Run actionlint
uses: reviewdog/action-actionlint@v1
with:
fail_level: any
actionlint_flags: '.github/workflows/*.yml'
2 changes: 0 additions & 2 deletions .github/workflows/audit.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
name: Security Audit

on:
schedule:
- cron: '0 0 * * *'
pull_request:
paths:
- 'Cargo.toml'

jobs:
cargo-deny:
runs-on: ubuntu-latest
Expand Down
Loading
Loading