Skip to content

Commit

Permalink
Minor update to development info
Browse files Browse the repository at this point in the history
  • Loading branch information
hirak99 committed May 9, 2024
1 parent 90390e0 commit 8df2a21
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,20 @@ information on using pull requests.
This project follows [Google's Open Source Community
Guidelines](https://opensource.google/conduct/).

## Prerequisites for Pull Request

This project uses the following for maintaining code styling, which you may
install for ease of development.
- [pyright](https://microsoft.github.io/pyright/#/)
([AUR](https://archlinux.org/packages/extra/any/pyright/)) for linting,
- [mypy](https://mypy-lang.org/)
([AUR](https://archlinux.org/packages/extra/any/mypy/)) for static type
checking, and
- [black](https://github.com/psf/black)
([AUR](https://archlinux.org/packages/extra/any/python-black/)) for
formatting.

Before creating a pull request, please run the following tests locally -
- `src/run_full_tests.sh` - Unit tests and linting / formatting checks.
- `scripts/scripts/test_install-to-dest.sh` - Tests the installation script.

10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
## Yet Another Btrfs Snapshotter

Note: You can now [port](https://github.com/hirak99/yabsnap/issues/32#issuecomment-2101080256) yabsnap to other backends also.

Note: Currently this is tested on Arch and Fedora, and should work in most other
Currently this is tested on Arch and Fedora, and should work in most other
distributions.

Note: Preliminary work has began to support non-btrfs (e.g. rsync, BCacheFS)
based snapshots. If you are a developer, [this
comment](https://github.com/hirak99/yabsnap/issues/32#issuecomment-2101080256)
explains the abstraction for implementing a new backend.


# Installing

## Arch Linux: Install from AUR
Expand Down

0 comments on commit 8df2a21

Please sign in to comment.