Skip to content

Commit d2f8037

Browse files
committed
Initial implementation
0 parents  commit d2f8037

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+7549
-0
lines changed

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
liberapay: creativcoder
2+
custom: ["https://www.buymeacoffee.com/creativcoder"]

.github/ISSUE_TEMPLATE/1-problem.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Problem
3+
about: Something does not seem right
4+
5+
---
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Suggestion
3+
about: Share how Avrow could support your use case better
4+
5+
---
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Documentation
3+
about: Certainly there is room for improvement
4+
5+
---

.github/workflows/ci.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
on: [push, pull_request]
2+
3+
jobs:
4+
linux:
5+
name: Test Suite (linux)
6+
runs-on: ubuntu-latest
7+
strategy:
8+
matrix:
9+
rust:
10+
- stable
11+
- nightly
12+
- 1.37.0
13+
steps:
14+
- uses: actions/checkout@v2
15+
- uses: actions-rs/toolchain@v1
16+
with:
17+
toolchain: ${{ matrix.rust }}
18+
- run: cargo test --release --all-features
19+
20+
windows:
21+
name: Test suite (windows)
22+
runs-on: windows-latest
23+
steps:
24+
- uses: actions/checkout@v2
25+
with:
26+
toolchain: ${{ matrix.rust }}
27+
- run: cargo test --all-features
28+
29+
lints:
30+
name: Lints
31+
runs-on: ubuntu-latest
32+
steps:
33+
- name: Checkout sources
34+
uses: actions/checkout@v2
35+
36+
- name: Install stable toolchain
37+
uses: actions-rs/toolchain@v1
38+
with:
39+
profile: minimal
40+
toolchain: stable
41+
override: true
42+
components: rustfmt, clippy
43+
44+
- name: Run cargo fmt
45+
uses: actions-rs/cargo@v1
46+
with:
47+
command: fmt
48+
args: --all -- --check
49+
50+
- name: Run cargo clippy
51+
uses: actions-rs/cargo@v1
52+
with:
53+
command: clippy
54+
args: -- -D warnings

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
/target
3+
**/*.rs.bk
4+
Cargo.lock
5+
NOTES.md
6+
*.avro
7+
*.jar
8+
experiments/
9+
TODO.md
10+
# .vscode
11+
avrow-cli/target

.vscode/launch.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"type": "lldb",
9+
"request": "launch",
10+
"name": "Debug",
11+
"program": "${workspaceFolder}/<your program>",
12+
"args": [],
13+
"cwd": "${workspaceFolder}"
14+
}
15+
]
16+
}

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
# [Unreleased]
8+
9+
10+
# [0.1.0] - 2020-10-08
11+
12+
## Added
13+
14+
Initial implementation of
15+
- avrow
16+
- avrow-cli (av)

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
## Code of Conduct
3+
4+
### Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to making participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, gender identity and expression, level of experience,
10+
nationality, personal appearance, race, religion, or sexual identity and
11+
orientation.
12+
13+
### Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual attention or
27+
advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
### Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
### Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
### Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
### Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at [http://contributor-covenant.org/version/1/4][version]
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
# Contributing
3+
4+
When contributing to this repository, please first discuss the change you wish to make via issue,
5+
email, or any other method with the owners of this repository before making a change.
6+
7+
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
8+
9+
## Pull Request Process
10+
11+
Following is a cursory guideline on how to make the process of making changes more efficient for the contributer and the maintainer.
12+
13+
1. File an issue for the change you want to make. This way we can track the why of the change.
14+
Get consensus from community for the change.
15+
2. Clone the project and perform a fresh build. Create a branch with the naming "feature/issue-number.
16+
3. Ensure that the PR only changes the parts of code which implements/solves the issue. This includes running
17+
the linter (cargo fmt) and removing any extra spaces and any formatting that accidentally were made by
18+
the code editor in use.
19+
4. If your PR has changes that should also reflect in README.md, please update that as well.
20+
5. Document non obvious changes and the `why` of your changes if it's unclear.
21+
6. If you are adding a public API, add the documentation as well.
22+
7. Increase the version numbers in Cargo.toml files and the README.md to the new version that this
23+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
24+
8. Update the CHANGELOG.md to reflect the change if applicable.
25+
26+
More details: https://github.community/t/best-practices-for-pull-requests/10195

0 commit comments

Comments
 (0)