Verified Commit 77f005ca authored by Jordan Petridis's avatar Jordan Petridis 🌱

Update Contributing.md

parent a63a6e16
......@@ -3,9 +3,11 @@
Please provide the source of the xml rss feed.
**Feed URL**
example.com/podcast
**Detailed description of the issue**.
**Detailed description of the issue**
Would be helpfull if error messages where included from stderr.
If you are not sure how to do it, feel free to ask and we will walk you through it!
......
......@@ -7,14 +7,3 @@ Steps to reproduce:
2. Do an action
3. ...
## Design Tasks
* [ ] design tasks
## Development Tasks
* [ ] development tasks
## QA Tasks
* [ ] qa (quality assurance) tasks
## Contributing
## Contributing to Hammond
Thank you for looking in this file!
When contributing to the development of Hammond, please first discuss the change you wish to make via issue, email, or any other method with the maintainers before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
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)
Please note we have a [code of conduct](https://wiki.gnome.org/Foundation/CodeOfConduc), please follow it in all your interactions with the project.
## Source repository
Hammond's main source repository is at gitlab.gnome.org. You can view
the web interface [here](https://gitlab.gnome.org/alatiera/hammond)
Development happens in the master branch.
Note that we don't do bug tracking in the Github mirror.
If you need to publish a branch, feel free to do it at any
publically-accessible Git hosting service, although gitlab.gnome.org
makes things easier for the maintainers.
## Style
We use rustfmt for code formatting and we enforce it on the gitlab-CI server.
We use [rustfmt](https://github.com/rust-lang-nursery/rustfmt) for code formatting and we enforce it on the gitlab-CI server.
Quick setup
```
cargo install rustfmt-nightly
cargo fmt --all
```
```
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 -- --test-threads=1 && cargo fmt --all -- --write-mode=diff
```
It is recommended to add a pre-commit hook to run cargo test and `cargo fmt`.
Don't forget to `git add` again after `cargo fmt`.
```
#!/bin/sh
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.
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
in [Hammond issue tracker](https://gitlab.gnome.org/alatiera/Hammond/issues). This is the
entry point for your contribution.
in [Hammond issue tracker](https://gitlab.gnome.org/alatiera/Hammond/issues). This is the entry point for your contribution.
To create an effective and high quality ticket, try to put the following information on your
ticket:
......
......@@ -8,7 +8,8 @@ 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:
......@@ -49,14 +50,14 @@ Flatpak instructions... Soon™.
* Gtk+ 3.22 or later
* Meson
**Debian/Ubuntu**:
**Debian/Ubuntu**
```sh
apt-get update -yqq
apt-get install -yqq --no-install-recommends build-essential
apt-get install -yqq --no-install-recommends libgtk-3-dev meson
```
**Fedora**:
**Fedora**
```sh
dnf install -y gtk3-devel glib2-devel openssl-devel sqlite-devel meson
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment