From 04ecb6fb7f8ab35493108d405358102c7c15574a Mon Sep 17 00:00:00 2001 From: Jordan Petridis Date: Mon, 13 Nov 2017 11:53:38 +0200 Subject: [PATCH] Updated Contributing.md and Added an achnoledment section to the Readme. --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 7 +++++++ 2 files changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96c1c0b..18fe44d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index db3bfe5..550c0d9 100644 --- a/README.md +++ b/README.md @@ -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. +