From 82a59d80dd73376a527475cd39f134134253fc23 Mon Sep 17 00:00:00 2001 From: Jordan Petridis Date: Wed, 13 Dec 2017 11:53:56 +0200 Subject: [PATCH] Update README.md and CONTRIBUTING.md --- CONTRIBUTING.md | 14 +++++++++++--- README.md | 11 +---------- hammond-gtk/src/views/shows.rs | 2 +- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1f3d07..2e46fdc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,12 @@ It is recommended to add a pre-commit hook to run cargo test and cargo fmt cargo test -- --test-threads=1 && cargo fmt --all -- --write-mode=diff ``` +## Running the test suite + +The test suite sets a temporary sqlite database in the /tmp folder. Due to that it's not possible to run them in parrallel. + +In order to run the test suite use the following: `cargo test -- --test-threads=1` + # Issues, issues and more issues! There are many ways you can contribute to Hammond, and all of them involve creating issues @@ -67,8 +73,10 @@ Steps to reproduce: ## Pull Request Process 1. Ensure your code compiles. Run `make` before creating the pull request. -2. If you're adding new API, it must be properly documented. -3. The commit message is formatted as follows: +2. Ensure the test suit passes. Run `cargo test -- --test-threads=1`. +3. Ensure your code is properly formated. Run `cargo fmt --all`. +4. If you're adding new API, it must be properly documented. +5. The commit message is formatted as follows: ``` component: @@ -78,7 +86,7 @@ Steps to reproduce: ``` -4. You may merge the pull request in once you have the sign-off of the maintainers, or if you +6. You may merge the pull request in once you have the sign-off of the maintainers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. ## Code of Conduct diff --git a/README.md b/README.md index 89a8a06..4d25ca6 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ This is a prototype of a podcast client written in Rust. ![podcast_widget](./assets/podcast_widget.png) ## Getting in Touch -If you have any questions regarding the -use or development of Hammond, want to discuss design or simply hang out, please join us in [#hammond on irc.gnome.org.](irc://irc.gnome.org/#hammond) +If you have any questions regarding the use or development of Hammond, want to discuss design or simply hang out, please join us in [#hammond on irc.gnome.org.](irc://irc.gnome.org/#hammond) Sidenote: @@ -70,14 +69,6 @@ cd Hammond/ cargo build --all ``` -## Call for designers - -Currently there no design plans or mockups. They are highly needed in order to advance the Gtk Client. - -There is the will for a complete client re-write if a someone contributes the mockups. - -If you happen to be a designer and want to contribute please hope on [#hammond](irc://irc.gnome.org/#hammond) and get in touch with us. - ## Contributing There alot of thins yet to be done. diff --git a/hammond-gtk/src/views/shows.rs b/hammond-gtk/src/views/shows.rs index 5b2ee98..bd9cf62 100644 --- a/hammond-gtk/src/views/shows.rs +++ b/hammond-gtk/src/views/shows.rs @@ -14,7 +14,7 @@ use std::rc::Rc; #[derive(Debug, Clone)] pub struct ShowsPopulated { pub container: gtk::Box, - pub flowbox: gtk::FlowBox, + flowbox: gtk::FlowBox, viewport: gtk::Viewport, }