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

Updated Contributing.md and Added an achnoledment section to the Readme.

Browse Source
This commit is contained in:
Jordan Petridis 2017-11-13 11:53:38 +02:00
parent be7b89dffb
commit 04ecb6fb7f
No known key found for this signature in database
GPG Key ID: CEABAD9F5683B9A6
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -6,6 +6,22 @@ When contributing to the development of Hammond, please first discuss the change
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Style
We use rustfmt for code formatting and we enforce it on the gitlab-CI server.
Quick setup
```
cargo install rustfmt-nightly
cargo fmt --all
```
It is recommended to add a pre-commit hook to run cargo test and cargo fmt
```
#!/bin/sh
cargo test --all && cargo fmt --all -- --write-mode=diff
```
## Pull Request Process
1. Ensure your code compiles. Run `make` before creating the pull request.

7
README.md
View File

@ -103,3 +103,10 @@ If you want to contribute, please check the [Contributions Guidelines][contribut
The project was named after Allan Moore's character [Evey Hammond](https://en.wikipedia.org/wiki/Evey_Hammond) from the graphic novel V for Vendetta.
It has nothing to do with the horrible headlines on the news.
## Acknowledgments
Hammond's design is heavily insired by [Gnome-Music](https://wiki.gnome.org/Design/Apps/Music) and [Vocal](http://vocalproject.net/).
We also copied some elements from [Gnome-news](https://wiki.gnome.org/Design/Apps/Potential/News).
And almost the entirety of the build system is copied from the [Fractal](https://gitlab.gnome.org/danigm/fractal) project.