Skip to content

Commit

Permalink
migrated to separate repository
Browse files Browse the repository at this point in the history
  • Loading branch information
jgraef committed Jul 24, 2024
1 parent 9cb48b0 commit 647c1f7
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 10 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing to skunk 🦨

First off, thank you for considering contributing to skunk 🦨.

There are plenty of [issues][1] to work on. Look for the [good first issue][3]
label if you want something easier first.

If your contribution is not straightforward, please first discuss the change
you wish to make in the relevant issue, or create a new one, if there isn't one
already.


## Reporting issues

Before reporting an issue on the [issue tracker][1], please check that it has
not already been reported by searching for some related keywords.

Try to use a clear title, and describe your problem with complete sentences.


## Workspace Setup

skunk currently requires rust nightly: `rustup override set nightly`.

The project's [README][2] has some guidance on how to setup the project for
development.


## Workflow

After making your changes make sure your changes compile and all tests pass
with `cargo test --all-features --workspace`.

Format the code with `cargo fmt`.


## Pull requests

Try to open one pull request per feature, patch, etc.


[1]: https://github.com/jgraef/skunk/issues
[2]: https://github.com/jgraef/skunk/tree/main#development
[3]: https://github.com/jgraef/skunk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
10 changes: 0 additions & 10 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,4 @@ resolver = "2"
members = [
"byst",
"byst-macros",
"skunk",
"skunk-api-client",
"skunk-api-protocol",
"skunk-cli",
"skunk-flow-store",
"skunk-macros",
"skunk-ui", "skunk-util",
]

[patch.crates-io]
reqwest-websocket = { git = "https://github.com/jgraef/reqwest-websocket.git", branch = "wasm-rewrite" }
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# bytes, bytter, `byst`!

Read and write bytes on steriods!

## What is this?

This is a utility crate for reading and writing bytes. It contains several buffer implementations, readers and writers for primitive types, and macros to derive readers and writers for structs and enums.

0 comments on commit 647c1f7

Please sign in to comment.