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

chore: Add/edit miscellaneous files #16

Merged
merged 12 commits into from
Feb 12, 2023
Merged
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
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[*.{rs}]
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 100
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Bug Report
description: File a bug report
labels: ["status: needs triage", "type: bug"]
body:
- type: checkboxes
id: tasks
attributes:
label: Please complete the following tasks
options:
- label: I have searched for any [existing issues](https://github.com/ev3nvy/rman-rs/issues?q=is%3Aissue)
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Brief summary of what happened and when it happened.
validations:
required: true
- type: textarea
id: what-was-expected
attributes:
label: What did you expect to see?
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
description: What operating system are you using?
options:
- Windows 11
- Windows 10
- other Windows (specify which below)
- macOS 13 (Ventura)
- macOS 12 (Monterey)
- macOS 11 (Big Sur)
- other macOS (specify which below)
- Linux (specify which flavor below)
- Other (specify which below)
- type: input
id: os-other
attributes:
label: Other OS info
desctiption: 'Extra information about the OS (if applicable):'
- type: input
id: rust-version
attributes:
label: Rust version
description: Use `rustc --version` to get the version.
validations:
required: true
- type: input
id: crate-version
attributes:
label: `rman` version
description: Which version of the `rman` crate are you using?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs
description: Please copy and paste any relevant output from when the error occured. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: other
attributes:
label: Other information
description: If you have any other relevant information you can provide it below.
placeholder: Other relevant information goes here
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Bug Report
description: File a bug report
labels: ["status: needs triage", "type: bug"]
body:
- type: checkboxes
id: tasks
attributes:
label: Please complete the following tasks
options:
- label: I have searched for any [existing issues](https://github.com/ev3nvy/rman-rs/issues?q=is%3Aissue)
required: true
- type: textarea
id: problem
attributes:
label: Problem
description: Describe what the problem or annoyance, you are facing, is.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution
description: Describe how you would like the problem to be solved, or what the solution would preferably look like.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative solutions
description: Describe other, alternative, solutions that would also solve the problem.
- type: input
id: crate-version
attributes:
label: `rman` version
description: Which version of the `rman` crate are you using?
validations:
required: true
- type: textarea
id: other
attributes:
label: Other information
description: If you have any other relevant information you can provide it below.
placeholder: Other relevant information goes here
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: I have a question or problem
url: https://discord.gg/5QVVBKBvpQ
about: Link to my Discord server.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- Thank you for your pull request. Make sure you read the contributing guidelines in
CONTRIBUTING.md -->
## Description
<!-- Describe what you changed, along with the related issue (if applicable). -->

## Motivation
<!-- Describe why you changed it. -->
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@ target/

Cargo.lock

*.manifest

.idea
.env
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"rust-lang.rust-analyzer",
]
}
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing

If you find any bugs or issues when using this crate, feel free to create an issue or open a
pull request.

## Setting up your development environment

Prerequisites:
- [rust](https://www.rust-lang.org)
- [clippy](https://github.com/rust-lang/rust-clippy) (installed alongside rust if `rustup` was
used for installation)
- [rust-fmt](https://github.com/rust-lang/rustfmt) (installed alongside rust if `rustup` was
used for installation)
- [flatc](https://github.com/google/flatbuffers) (see
[`Building` section](https://github.com/ev3nvy/rman-schema#building) in
[rman-schema](https://github.com/ev3nvy/rman-schema))

### 1. Clone the project:

```bash
git clone --recurse-submodules https://github.com/ev3nvy/rman-rs.git
```

> Note the `--recurse-submodules` part, which is required beacuse the schema in the linked submodule
is part of the build process.

### 2. Make the desired changes.

### 3. Check if the code compiles:

```bash
cargo check
```

### 4. Run clippy:

```bash
cargo clippy
```

### 5. Run cargo-fmt

```bash
cargo fmt
```

### 6. Run tests

```bash
cargo test
cargo test --all-features
```

### 7. Open a Pull Request
8 changes: 7 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
[package]
name = "rman-rs"
name = "rman"
version = "0.1.0"
authors = ["ev3nvy"]
edition = "2021"
description = "Parser for Riot Manifest file format."
repository = "https://github.com/ev3nvy/rman-rs"
license = "MIT OR Apache-2.0"
keywords = ["rman", "riot", "rito", "manifest", "riot-manifest"]
categories = ["data-structures", "encoding", "parser-implementations"]

[dependencies]
byteorder = "1.4.3"
Expand Down
Loading