Initial draft of contributing.md.

This commit is contained in:
Jordan Petridis 2017-11-13 09:47:09 +02:00
parent f635f60ad8
commit c2d0254a06
No known key found for this signature in database
GPG Key ID: CEABAD9F5683B9A6
3 changed files with 54 additions and 15 deletions

27
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,27 @@
## Contributing
Contributing
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.
## 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:
```
component: <summary>
A paragraph explaining the problem and its context.
Another one explaining how you solved that.
<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
do not have permission to do that, you may request the second reviewer to merge it for you.
## Code of Conduct
We follow the Gnome [Code of Conduct.](https://wiki.gnome.org/Foundation/CodeOfConduct)

View File

@ -7,17 +7,25 @@ This is a prototype of a podcast client written in Rust.
![podcasts_view](./assets/podcasts_view.png) ![podcasts_view](./assets/podcasts_view.png)
![podcast_widget](./assets/podcast_widget.png) ![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
with nice folks, please join us in #hammond on irc.gnome.org.
Sidenote:
There isn't much documentation yet, so you will probably have question about parts of the Code.
## Quick start
The following steps assume you have a working installation of rustc and cargo. The following steps assume you have a working installation of rustc and cargo.
If you dont take a look at [rustup.rs](rustup.rs) If you dont take a look at [rustup.rs](rustup.rs)
## Quick start:
```sh ```sh
git clone https://gitlab.gnome.org/alatiera/hammond.git git clone https://gitlab.gnome.org/alatiera/hammond.git
cd Hammond/ cd Hammond/
cargo run -p hammond-gtk --release cargo run -p hammond-gtk --release
``` ```
## Install from soure: ## Install from soure
```sh ```sh
git clone https://gitlab.gnome.org/alatiera/hammond.git git clone https://gitlab.gnome.org/alatiera/hammond.git
cd Hammond/ cd Hammond/
@ -31,37 +39,37 @@ You can run `sudo make uninstall` for removal
And `make clean` to clean up the enviroment after instalation. And `make clean` to clean up the enviroment after instalation.
### Flatpak: ### Flatpak
Flatpak instructions... Soon™. Flatpak instructions... Soon™.
## Dependancies: ## Building
### Dependancies
* Rust stable 1.21 or later. * Rust stable 1.21 or later.
* Gtk+ 3.22 or later * Gtk+ 3.22 or later
* Meson
**Debian/Ubuntu**: **Debian/Ubuntu**:
```sh ```sh
apt-get update -yqq apt-get update -yqq
apt-get install -yqq --no-install-recommends build-essential apt-get install -yqq --no-install-recommends build-essential
apt-get install -yqq --no-install-recommends libgtk-3-dev apt-get install -yqq --no-install-recommends libgtk-3-dev meson
``` ```
**Fedora**: **Fedora**:
```sh ```sh
dnf install -y gtk3-devel glib2-devel openssl-devel sqlite-devel dnf install -y gtk3-devel glib2-devel openssl-devel sqlite-devel meson
``` ```
If you happen to build it on other distributions please let me know the names of the corresponding libraries. Feel free to open a PR or an Issue to note it. If you happen to build it on other distributions please let me know the names of the corresponding libraries. Feel free to open a PR or an Issue to note it.
## Building:
```sh ```sh
git clone https://gitlab.gnome.org/alatiera/Hammond.git git clone https://gitlab.gnome.org/alatiera/Hammond.git
cd Hammond/ cd Hammond/
cargo build --all cargo build --all
``` ```
## Overview: ## Overview
```sh ```sh
$ tree -d $ tree -d
@ -82,12 +90,15 @@ $ tree -d
│   └── widgets # Contains custom widgets such as Podcast and Episode. │   └── widgets # Contains custom widgets such as Podcast and Episode.
``` ```
## Contributing: ## Contributing
There alot of thins to be done, take a look at TODO.md or grep for TODO: and FIXME:. There alot of thins yet to be done.
You can find start by taking a look at [Issues](https://gitlab.gnome.org/alatiera/Hammond/issues) or Opening a [New one](https://gitlab.gnome.org/alatiera/Hammond/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=).
You may also want to take a look at [TODO.md](https://gitlab.gnome.org/alatiera/Hammond/blob/master/TODO.md) or grep the source code for `TODO:` and `FIXME:` tags.
to be added: CONTRIBUTING.md If you want to contribute, please check the [Contributions Guidelines][contribution-guidelines].
[contribution-guidelines]: https://gitlab.gnome.org/GNOME/gnome-todo/blob/master/CONTRIBUTING.md
## A note about the project's name: ## A note about the project's name
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. 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.

View File

@ -2,7 +2,8 @@
**General:** **General:**
- [ ] Add CONTRIBUTING.md - [x] Add CONTRIBUTING.md
- [ ] Add Issues and Pull Request templates
- [ ] Write docs - [ ] Write docs