Skip to content

Latest commit

 

History

History
130 lines (85 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

130 lines (85 loc) · 4.01 KB
Raw

Contributing to GNOME Podcasts

Thank you for looking in this file!

When contributing to the development of GNOME Podcasts, please first discuss the change you wish to make via issue, email, or any other method with the maintainers before making a change.

If you have any questions regarding the use or development of GNOME Podcasts, want to discuss design or simply hang out, please join us in #podcasts:gnome.org or #hammond on irc.gnome.org.

Code of Conduct

Please note we follow the GNOME Foundation Code of Conduct, please adhere to it in all your interactions with the project.

Source repository

GNOME Podcasts's main source repository is at gitlab.gnome.org. You can view the web interface here

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.

Development Builds

Set up the project with the development profile with:

meson setup _build -Dprofile=development

You can compile the project with:

meson compile -C _build

Style

We use rustfmt for code formatting and we enforce it on the GitLab CI server.

Our continuous integration pipeline assumes the version of rustfmt that is distributed through the stable channel of rustup. You can install it with:

rustup component add rustfmt
cargo fmt --all

It is recommended to add a pre-commit hook to run tests and cargo fmt. Don't forget to git add again after cargo fmt.

#!/bin/sh
meson test -C _build && cargo fmt --all -- --check

Running the test suite

Running the tests requires an internet connection and will download some files from the Internet Archive.

The test suite sets a temporary sqlite database in the /tmp folder. Due to that it's not possible to run them in parallel.

In order to run the test suite use the following: meson test -C _build

Issues, issues and more issues!

There are many ways you can contribute to GNOME Podcasts, and all of them involve creating issues in GNOME Podcasts issue tracker. 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:

  1. A detailed description of the issue or feature request
    • For issues, please add the necessary steps to reproduce the issue.
    • For feature requests, add a detailed description of your proposal.
  2. A checklist of Development tasks
  3. A checklist of Design tasks
  4. A checklist of QA tasks

Issue template

[Title of the issue or feature request]

Detailed description of the issue. Put as much information as you can, potentially
with images showing the issue or mockups of the proposed feature.

If it's an issue, add the steps to reproduce like this:

Steps to reproduce:

1. Open GNOME Podcasts
2. Do an Action
3. ...

## Design Tasks

* [ ]  design tasks

## Development Tasks

* [ ]  development tasks

## QA Tasks

* [ ]  qa (quality assurance) tasks

Merge Request Process

  1. Ensure your code compiles. Run meson & ninja before creating the merge request.
  2. Ensure the test suit passes. Run meson test -C _build.
  3. Ensure your code is properly formatted. Run cargo fmt --all.
  4. If you're adding new API, it must be properly documented.
  5. The commit message has to be 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>
  6. You may merge the merge request 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.