Integrate ruma-federation-api
This commit is contained in:
Jonas Platte
parent
10bd7d5f95
commit
19ce9645b6
@ -1,27 +0,0 @@
|
||||
image: archlinux
|
||||
packages:
|
||||
- rustup
|
||||
sources:
|
||||
- https://github.com/ruma/ruma-federation-api
|
||||
tasks:
|
||||
- rustup: |
|
||||
# We specify --profile minimal because we'd otherwise download docs
|
||||
rustup toolchain install beta --profile minimal -c rustfmt -c clippy
|
||||
rustup default beta
|
||||
- test: |
|
||||
cd ruma-federation-api
|
||||
|
||||
# We don't want the build to stop on individual failure of independent
|
||||
# tools, so capture tool exit codes and set the task exit code manually
|
||||
set +e
|
||||
|
||||
cargo fmt -- --check
|
||||
fmt_exit=$?
|
||||
|
||||
cargo clippy --all-targets --all-features -- -D warnings
|
||||
clippy_exit=$?
|
||||
|
||||
cargo test --verbose
|
||||
test_exit=$?
|
||||
|
||||
exit $(( $fmt_exit || $clippy_exit || $test_exit ))
|
||||
@ -1,16 +0,0 @@
|
||||
image: archlinux
|
||||
packages:
|
||||
- rustup
|
||||
sources:
|
||||
- https://github.com/ruma/ruma-federation-api
|
||||
tasks:
|
||||
- rustup: |
|
||||
# We specify --profile minimal because we'd otherwise download docs
|
||||
rustup toolchain install 1.40.0 --profile minimal
|
||||
rustup default 1.40.0
|
||||
- test: |
|
||||
cd ruma-federation-api
|
||||
|
||||
# Only make sure the code builds with the MSRV. Tests can require later
|
||||
# Rust versions, don't compile or run them.
|
||||
cargo build --verbose
|
||||
@ -1,32 +0,0 @@
|
||||
image: archlinux
|
||||
packages:
|
||||
- rustup
|
||||
sources:
|
||||
- https://github.com/ruma/ruma-federation-api
|
||||
tasks:
|
||||
- rustup: |
|
||||
rustup toolchain install nightly --profile minimal
|
||||
rustup default nightly
|
||||
|
||||
# Try installing rustfmt & clippy for nightly, but don't fail the build
|
||||
# if they are not available
|
||||
rustup component add rustfmt || true
|
||||
rustup component add clippy || true
|
||||
- test: |
|
||||
cd ruma-federation-api
|
||||
|
||||
# We don't want the build to stop on individual failure of independent
|
||||
# tools, so capture tool exit codes and set the task exit code manually
|
||||
set +e
|
||||
|
||||
if ( rustup component list | grep -q rustfmt ); then
|
||||
cargo fmt -- --check
|
||||
fi
|
||||
fmt_exit=$?
|
||||
|
||||
if ( rustup component list | grep -q clippy ); then
|
||||
cargo clippy --all-targets --all-features -- -D warnings
|
||||
fi
|
||||
clippy_exit=$?
|
||||
|
||||
exit $(( $fmt_exit || $clippy_exit ))
|
||||
@ -1,29 +0,0 @@
|
||||
image: archlinux
|
||||
packages:
|
||||
- rustup
|
||||
sources:
|
||||
- https://github.com/ruma/ruma-federation-api
|
||||
tasks:
|
||||
- rustup: |
|
||||
# We specify --profile minimal because we'd otherwise download docs
|
||||
rustup toolchain install stable --profile minimal -c rustfmt -c clippy
|
||||
rustup default stable
|
||||
- test: |
|
||||
cd ruma-federation-api
|
||||
|
||||
# We don't want the build to stop on individual failure of independent
|
||||
# tools, so capture tool exit codes and set the task exit code manually
|
||||
set +e
|
||||
|
||||
cargo fmt -- --check
|
||||
fmt_exit=$?
|
||||
|
||||
cargo clippy --all-targets --all-features -- -D warnings
|
||||
clippy_exit=$?
|
||||
|
||||
cargo test --verbose
|
||||
test_exit=$?
|
||||
|
||||
exit $(( $fmt_exit || $clippy_exit || $test_exit ))
|
||||
# TODO: Add audit task once cargo-audit binary releases are available.
|
||||
# See https://github.com/RustSec/cargo-audit/issues/66
|
||||
2
ruma-federation-api/.gitignore
vendored
2
ruma-federation-api/.gitignore
vendored
@ -1,2 +0,0 @@
|
||||
Cargo.lock
|
||||
target
|
||||
@ -1,181 +0,0 @@
|
||||
Welcome! Thanks for looking into contributing to our project!
|
||||
|
||||
# Table of Contents
|
||||
|
||||
- [Looking for Help?](#looking-for-help)
|
||||
- [Documentation](#documentation)
|
||||
- [Chat Rooms](#chat-rooms)
|
||||
- [Reporting Issues](#reporting-issues)
|
||||
- [Submitting Code](#submitting-code)
|
||||
- [Coding Style](#coding-style)
|
||||
- [Modifying Endpoints](#modifying-endpoints)
|
||||
- [Submitting PRs](#submitting-prs)
|
||||
- [Where do I start?](#where-do-i-start)
|
||||
- [Testing](#testing)
|
||||
- [Contact](#contact)
|
||||
|
||||
# Looking for Help?
|
||||
|
||||
Here is a list of helpful resources you can consult:
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Matrix Federation API specification](https://matrix.org/docs/spec/server_server/latest)
|
||||
- Documentation to other Ruma modules:
|
||||
- [ruma-events](https://docs.rs/ruma-events/)
|
||||
- [ruma-api](https://docs.rs/ruma-api/)
|
||||
- [ruma-client](https://docs.rs/ruma-client/)
|
||||
|
||||
## Chat Rooms
|
||||
|
||||
- Ruma Matrix room: [#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org)
|
||||
- Matrix Developer room: [#matrix-dev:matrix.org](https://matrix.to/#/#matrix-dev:matrix.org)
|
||||
- Matrix Homeserver developers room: [#homeservers-dev:matrix.org](https://matrix.to/#/#homerservers-dev:matrix.org)
|
||||
|
||||
# Reporting Issues
|
||||
|
||||
If you find any bugs, inconsistencies or other problems, feel free to submit
|
||||
a GitHub [issue](issues).
|
||||
|
||||
If you have a quick question, it may be easier to leave a message on
|
||||
[#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org).
|
||||
|
||||
Also, if you have trouble getting on board, let us know so we can help future
|
||||
contributors to the project overcome that hurdle too.
|
||||
|
||||
# Submitting Code
|
||||
|
||||
Ready to write some code? Great! Here are some guidelines to follow to
|
||||
help you on your way:
|
||||
|
||||
## Coding Style
|
||||
|
||||
### Import Formatting
|
||||
|
||||
Organize your imports into three groups separated by blank lines:
|
||||
|
||||
1. `std` imports
|
||||
1. External imports (from other crates)
|
||||
1. Local imports (`self::`, `super::`, `crate::` and things like `LocalType::*`)
|
||||
|
||||
For example,
|
||||
|
||||
```rust
|
||||
use std::collections::HashMap;
|
||||
|
||||
use ruma_api::ruma_api;
|
||||
|
||||
use super::MyType;
|
||||
```
|
||||
|
||||
Also, group imports by module. For example, do this:
|
||||
|
||||
```rust
|
||||
use std::{
|
||||
collections::HashMap,
|
||||
convert::TryFrom,
|
||||
fmt::{Debug, Display, Error as FmtError, Formatter},
|
||||
};
|
||||
```
|
||||
|
||||
as opposed to:
|
||||
|
||||
```rust
|
||||
use std::collections::HashMap;
|
||||
use std::convert::TryFrom;
|
||||
use std::fmt::{Debug, Display, Error as FmtError, Formatter};
|
||||
```
|
||||
|
||||
### Code Formatting and Linting
|
||||
|
||||
Use `rustfmt` to format your code and `clippy` to lint your code. Before
|
||||
committing your changes, go ahead and run `cargo fmt` and `cargo clippy
|
||||
--all-targets --all-features` on the repository to make sure that the
|
||||
formatting and linting checks pass in CI. Note that `clippy` warnings are
|
||||
reported as errors in CI builds, so make sure to handle those before
|
||||
comitting as well. (To install the tools, run `rustup component add rustfmt
|
||||
clippy`.)
|
||||
|
||||
#### Git hooks
|
||||
Tip: You may want to add these commands to your pre-commit git hook so you don't get bitten by CI.
|
||||
|
||||
```sh
|
||||
# ./git/hooks/pre-commit
|
||||
cargo fmt && cargo clippy --all-targets --allfeatures
|
||||
```
|
||||
|
||||
### Commit Messages
|
||||
|
||||
Write commit messages using the imperative mood, as if completing the sentence:
|
||||
"If applied, this commit will \_\_\_." For example, use "Fix some bug" instead
|
||||
of "Fixed some bug" or "Add a feature" instead of "Added a feature".
|
||||
|
||||
(Take a look at this
|
||||
[blog post](https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/)
|
||||
for more information on writing good commit messages.)
|
||||
|
||||
## Modifying Endpoints
|
||||
|
||||
### Matrix Spec Version
|
||||
|
||||
Use the latest r0.x.x documentation when adding or modifying code. We target
|
||||
the latest minor version of the Matrix specification. (Note: We might
|
||||
reconsider this when the Federation API hits r1.0.0.)
|
||||
|
||||
### Endpoint Documentation Header
|
||||
|
||||
Add a comment to the top of each endpoint file that includes the path
|
||||
and a link to the documentation of the spec. You can use the latest
|
||||
version at the time of the commit. For example:
|
||||
|
||||
```rust
|
||||
//! [GET /.well-known/matrix/server](https://matrix.org/docs/spec/server_server/r0.1.3#get-well-known-matrix-server)
|
||||
```
|
||||
|
||||
### Naming Endpoints
|
||||
|
||||
When adding new endpoints, select the module that fits the purpose of the
|
||||
endpoint. When naming the endpoint itself, you can use the following
|
||||
guidelines:
|
||||
- The name should be a verb describing what the client is requesting, e.g.
|
||||
`get_some_resource`.
|
||||
- Endpoints which are basic CRUD operations should use the prefixes
|
||||
`create`, `get`, `update`, and `delete`.
|
||||
- The prefix `set` is preferred to create if the resource is a singleton.
|
||||
In other words, when there's no distinction between `create` and `update`.
|
||||
- Try to use names that are as descriptive as possible and distinct from
|
||||
other endpoints in all other modules. (For example, instead of
|
||||
`membership::create_event::v1`, use `membership::create_join_event::v1`).
|
||||
- If you're not sure what to name it, pick any name and we can help you
|
||||
with it.
|
||||
|
||||
### Tracking Changes
|
||||
|
||||
Add your changes to the [change log](CHANGELOG.md). If possible, try to
|
||||
find and denote the version of the spec that included the change you are
|
||||
making.
|
||||
|
||||
## Submitting PRs
|
||||
|
||||
Once you're ready to submit your code, create a pull request, and one of our
|
||||
maintainers will review it. Once your PR has passed review, a maintainer will
|
||||
merge the request and you're done! 🎉
|
||||
|
||||
## Where do I start?
|
||||
|
||||
If this is your first contribution to the project, we recommend taking a look
|
||||
at one of the [open issues][] we've marked for new contributors.
|
||||
|
||||
It may be helpful to peruse some of the documentation for `ruma-events` and
|
||||
`ruma-api` listed above for some context.
|
||||
|
||||
[open issues]: https://github.com/ruma/ruma-federation-api/issues?q=is%3Aopen+is%3Aissue+label%3Aeffort%2Feasy
|
||||
|
||||
# Testing
|
||||
|
||||
Before committing, run `cargo check` to make sure that your changes can build, as well as running the formatting and linting tools [mentioned above](#code-formatting-and-linting).
|
||||
|
||||
# Contact
|
||||
|
||||
Thanks again for being a contributor! If you have any questions, join us at
|
||||
[#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org).
|
||||
@ -1,10 +1,13 @@
|
||||
[package]
|
||||
authors = ["Jonas Platte <jplatte+git@posteo.de>"]
|
||||
authors = [
|
||||
"Jonas Platte <jplatte+git@posteo.de>",
|
||||
"Isaiah Inuwa <isaiah.inuwa@gmail.com>",
|
||||
]
|
||||
categories = ["api-bindings", "web-programming"]
|
||||
description = "Types for the endpoints in the Matrix server-server API."
|
||||
documentation = "https://docs.rs/ruma-federation-api"
|
||||
edition = "2018"
|
||||
homepage = "https://github.com/ruma/ruma-federation-api"
|
||||
homepage = "https://www.ruma.io/"
|
||||
keywords = ["matrix", "chat", "messaging", "ruma"]
|
||||
license = "MIT"
|
||||
name = "ruma-federation-api"
|
||||
@ -15,8 +18,8 @@ version = "0.0.2"
|
||||
[dependencies]
|
||||
js_int = "0.1.5"
|
||||
matches = "0.1.8"
|
||||
ruma-api = "0.16.1"
|
||||
ruma-events = "0.21.3"
|
||||
ruma-api = { version = "0.16.1", path = "../ruma-api" }
|
||||
ruma-events = { git = "https://github.com/ruma/ruma-events", rev = "c1ee72d" }
|
||||
ruma-identifiers = "0.16.2"
|
||||
ruma-serde = "0.2.2"
|
||||
serde = { version = "1.0.111", features = ["derive"] }
|
||||
|
||||
@ -30,4 +30,4 @@ ruma-signatures = { version = "0.6.0-dev.1", path = "../ruma-signatures", option
|
||||
ruma-api = { version = "0.16.1", path = "../ruma-api", optional = true }
|
||||
ruma-appservice-api = { version = "0.1.0", path = "../ruma-appservice-api", optional = true }
|
||||
ruma-client-api = { version = "0.9.0", path = "../ruma-client-api", optional = true }
|
||||
ruma-federation-api = { version = "0.0.2", optional = true }
|
||||
ruma-federation-api = { version = "0.0.2", path = "../ruma-federation-api", optional = true }
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user