https://github.com/ucan-wg/conformance-tests
UCAN fixtures for testing conformance
https://github.com/ucan-wg/conformance-tests
authorization conformance ucan
Last synced: 18 days ago
JSON representation
UCAN fixtures for testing conformance
- Host: GitHub
- URL: https://github.com/ucan-wg/conformance-tests
- Owner: ucan-wg
- License: apache-2.0
- Created: 2023-07-25T15:44:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-17T17:41:43.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T02:51:13.906Z (about 2 years ago)
- Topics: authorization, conformance, ucan
- Language: Rust
- Homepage: https://ucan-wg.github.io/conformance-tests/
- Size: 841 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
ucan-fixture-generator
:warning: Work in progress :warning:
##
## Outline
- [Installation](#installation)
- [Testing the Project](#testing-the-project)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [External Resources](#external-resources)
- [License](#license)
## Installation
### Using `cargo`
```console
cargo install ucan-fixture-generator
```
## Testing the Project
- Run tests
```console
cargo test
```
## Contributing
:balloon: We're thankful for any feedback and help in improving our project!
We have a [contributing guide](./CONTRIBUTING.md) to help you get involved. We
also adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).
### Nix
This repository contains a [Nix flake][nix-flake] that initiates both the Rust
toolchain set in [rust-toolchain.toml](./rust-toolchain.toml) and a
[pre-commit hook](#pre-commit-hook). It also installs helpful cargo binaries for
development. Please install [nix][nix] and [direnv][direnv] to get started.
Run `nix develop` or `direnv allow` to load the `devShell` flake output,
according to your preference.
### Formatting
For formatting Rust in particular, we automatically format on `nightly`, as it
uses specific nightly features we recommend by default.
### Pre-commit Hook
This project recommends using [pre-commit][pre-commit] for running pre-commit
hooks. Please run this before every commit and/or push.
- If you are doing interim commits locally, and for some reason if you _don't_
want pre-commit hooks to fire, you can run
`git commit -a -m "Your message here" --no-verify`.
### Recommended Development Flow
- We recommend leveraging [cargo-watch][cargo-watch],
[cargo-expand][cargo-expand] and [irust][irust] for Rust development.
- We recommend using [cargo-udeps][cargo-udeps] for removing unused dependencies
before commits and pull-requests.
### Conventional Commits
This project *lightly* follows the [Conventional Commits
convention][commit-spec-site] to help explain
commit history and tie in with our release process. The full specification
can be found [here][commit-spec]. We recommend prefixing your commits with
a type of `fix`, `feat`, `docs`, `ci`, `refactor`, etc..., structured like so:
```
[optional scope]:
[optional body]
[optional footer(s)]
```
## Getting Help
For usage questions, usecases, or issues please open an issue in our repository.
We would be happy to try to answer your question or try opening a new issue on Github.
## External Resources
These are references to specifications, talks and presentations, etc.
## License
This project is licensed under the [Apache License 2.0](./LICENSE), or
[http://www.apache.org/licenses/LICENSE-2.0][apache].
[apache]: https://www.apache.org/licenses/LICENSE-2.0
[cargo-expand]: https://github.com/dtolnay/cargo-expand
[cargo-udeps]: https://github.com/est31/cargo-udeps
[cargo-watch]: https://github.com/watchexec/cargo-watch
[commit-spec]: https://www.conventionalcommits.org/en/v1.0.0/#specification
[commit-spec-site]: https://www.conventionalcommits.org/
[direnv]:https://direnv.net/
[irust]: https://github.com/sigmaSd/IRust
[nix]:https://nixos.org/download.html
[nix-flake]: https://nixos.wiki/wiki/Flakes
[pre-commit]: https://pre-commit.com/