Skip to content

Commit fc3ebe3

Browse files
VimsRoczVimsRocz
committed
chore: add MIT license and community files
1 parent 3862e11 commit fc3ebe3

12 files changed

Lines changed: 194 additions & 1 deletion

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.{m,mlx}]
10+
indent_style = space
11+
indent_size = 4
12+
13+
[*.md]
14+
indent_style = space
15+
indent_size = 2
16+
17+
[*.{yml,yaml}]
18+
indent_style = space
19+
indent_size = 2
20+

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Bug report
2+
description: Report something that is broken or incorrect.
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
placeholder: Clear and concise description of the bug.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: steps
15+
attributes:
16+
label: Steps to reproduce
17+
placeholder: |
18+
1. ...
19+
2. ...
20+
3. ...
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: environment
26+
attributes:
27+
label: Environment
28+
placeholder: |
29+
- OS:
30+
- MATLAB/Octave version:
31+
validations:
32+
required: false
33+

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Feature request
2+
description: Suggest an improvement or new feature.
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: proposal
7+
attributes:
8+
label: Proposed solution
9+
placeholder: What would you like to see added/changed?
10+
validations:
11+
required: true
12+

‎.github/pull_request_template.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Summary
2+
3+
<!-- What does this PR change and why? -->
4+
5+
## Checklist
6+
7+
- [ ] I updated docs if needed
8+

‎.github/workflows/ci.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
housekeeping:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-python@v5
17+
with:
18+
python-version: "3.12"
19+
- name: Install pre-commit
20+
run: python -m pip install -U pip pre-commit
21+
- name: Run pre-commit
22+
run: pre-commit run --all-files
23+

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# macOS
2+
.DS_Store
3+
4+
# Editor backups
5+
*~
6+

‎.pre-commit-config.yaml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.6.0
4+
hooks:
5+
- id: check-merge-conflict
6+
- id: check-case-conflict
7+
- id: trailing-whitespace
8+
- id: end-of-file-fixer
9+

‎CODE_OF_CONDUCT.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Enforcement
16+
17+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
18+
reported by contacting the project team at vimsrocz@gmail.com.
19+
20+
## Attribution
21+
22+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1.
23+

‎CONTRIBUTING.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
Thanks for your interest in improving this project!
4+
5+
## What to include in bug reports
6+
7+
- MATLAB version (or Octave version if applicable)
8+
- OS (Windows/macOS/Linux)
9+
- Steps to reproduce
10+
- Expected vs actual results
11+
12+
## Pull requests
13+
14+
- Keep changes small and focused.
15+
- Update `README.md` if you change usage or outputs.
16+

‎LICENSE‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2026 VimsRocz
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

0 commit comments

Comments
 (0)