toxblh/podcasts
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md and CONTRIBUTING.md

Browse Source
This commit is contained in:
Jordan Petridis 2017-12-13 11:53:56 +02:00
parent 5defb5867a
commit 82a59d80dd
No known key found for this signature in database
GPG Key ID: CEABAD9F5683B9A6
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -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: <summary>
@ -78,7 +86,7 @@ Steps to reproduce:
<link to the bug ticket>
```
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

11
README.md
View File

@ -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.

2
hammond-gtk/src/views/shows.rs
View File

@ -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,
}