Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notes about development tools we use #951

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add notes about development tools we use #951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,31 @@

This document is intended for software engineers and translators who would like to help out with the development of Cozy, or simply be able to run bleeding edge versions of the code locally.

## Code style

To ensure good quality code, we lint our codebase with Ruff. We recommend that you run Ruff before pushing your changes to GitHub and correct the warnings, otherwise the automatic checks on pull requests will fail.

```
ruff check <filename>
```

For consistent code style, we format the source files using `black` and `isort`. Run these two tools on the changed files before committing.

```
black cozy
isort cozy
```

You can install these tools via pip:

```
pip install black isort ruff
```


## Building with GNOME Builder (recommended)

Cozy can be built and run with [GNOME Builder](https://apps.gnome.org/Builder/).
We recommend using [GNOME Builder](https://apps.gnome.org/Builder/) to build and run Cozy.

1. Open GNOME Builder
2. Click the **Clone Repository** button
Expand Down