Skip to content

Commit

Permalink
Improve README about contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
LJ authored and LJ committed Jul 25, 2024
1 parent 71d6c3c commit 0a8140a
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If you're looking for a more mature project, please consider looking at their [g

I disliked the generated nature of it though, and wanted more strong Rust-like things for some things, which is why this crate exists.

There's quite a bit missing, PRs are welcome to improve the situation, even beyond the plans:
There's quite a bit missing, if you want to help with that, see [contributing](#contributing).

| Status | Category | Planned |
| --- | --- | --- |
Expand All @@ -25,7 +25,7 @@ There's quite a bit missing, PRs are welcome to improve the situation, even beyo
| None | Favorites | Eventual implementation |
| None | Files | None |
| Partial | Friends | Implementation soon |
| Partial | Groups | More testing |
| Partial | Groups | More testing (requires VRC+ :/ ) |
| None | Invites | Listing invites only |
| Partial | Instances | Implementation soon |
| None | Notifications | Eventual implementation |
Expand Down Expand Up @@ -72,6 +72,23 @@ cargo test --all-features current_user -- --exact --ignored --nocapture
cargo test --all-features -- --ignored
```

## Contributing

### Coding

This crate aims to be of higher quality vs quantity.
This means that the bar for what gets merged is maybe higher than some want to bother with.
Please run the clippy checks along with nightly cargo formatting, and check that the CI checks pass.

Any contributions are welcome though, just mark the PR as editable by maintainers.
That way even if you don't feel like acting out on the feedback, the improvements will most likely eventually find their way back to here.

### Other

Alternatively if you don't feel like coding, creating GitHub issues for wrong behavior would be very welcome.
Additionally, figuring out the actual data types and inheritance models, and improving the docs would really help with development!
Also just starring this GitHub repository helps with motivation for more work on this crate that serves other projects as well.

## License

Note that the license is `MPL-2.0` instead of the more common `MIT OR Apache-2.0`.

0 comments on commit 0a8140a

Please sign in to comment.