Skip to content

Commit

Permalink
📝 Update documentation - Paging and add Discord link
Browse files Browse the repository at this point in the history
  • Loading branch information
mehdichaouch committed Sep 22, 2024
1 parent 8ac890d commit 30d5772
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 17 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,41 +53,41 @@ use editors with SFTP support.

If you haven't done so yet, fork the repository on GitHub, then add this fork
to your rabbit's repository.
```
cd /opt/pynab
```sh
cd $HOME/pynab
git remote add fork https://github.com/YOUR_GITHUB_USERNAME/pynab.git
```

To develop your code, create a local branch with a name that makes sense.
```
```sh
git fetch origin
git checkout -b feature-name origin/master
```

At anytime, you can run tests locally (on the rabbit) by first stopping pynab
and services. Hardware tests require root access.
```
```sh
sudo ./venv/bin/python manage.py stop_all
sudo ./venv/bin/pytest
sudo ./venv/bin/python manage.py start_all
```

Before committing your code, make sure the style is conforming by running pre-commit
```
```sh
./venv/bin/pre-commit
```

Once you are happy with the result, rebase and push it to a dedicated branch on
your own GitHub fork.
```
```sh
git fetch origin
git rebase origin/master
git push fork HEAD:feature-name
```

GitHub will display the URL to create a pull request, with a git message such
as:
```
```sh
remote:
remote: Create a pull request for 'branch-name' on GitHub by visiting:
remote: https://github.com/user/pynab/pull/new/branch-name
Expand All @@ -104,7 +104,7 @@ If tests fail, fix them and push to the branch, either with new commits or
by amending. Once tests pass, your request will be reviewed.

At any time, if you did commit your changes, you can go back to master with:
```
```sh
git fetch origin
git checkout master
bash upgrade.sh
Expand Down
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# Nabaztag en Python pour Raspberry Pi

[![build (qemu)](https://github.com/nabaztag2018/pynab/actions/workflows/arm-runner.yml/badge.svg?branch=master)](https://github.com/nabaztag2018/pynab/actions/workflows/arm-runner.yml)
[![tests](https://github.com/nabaztag2018/pynab/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/nabaztag2018/pynab/actions/workflows/tests.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/nabaztag2018/pynab.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/nabaztag2018/pynab/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/nabaztag2018/pynab.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/nabaztag2018/pynab/context:python)
[![codecov](https://codecov.io/gh/nabaztag2018/pynab/branch/master/graph/badge.svg)](https://codecov.io/gh/nabaztag2018/pynab)
[![Twitter](https://img.shields.io/twitter/follow/nabaztagtagtag?label=Follow&style=social)](https://twitter.com/nabaztagtagtag)
<h1 align="center"><a href="https://github.com/nabaztag2018/pynab">Nabaztag en Python pour Raspberry Pi</a></h1>
<p align="center">
<a href="https://lgtm.com/projects/g/nabaztag2018/pynab/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/nabaztag2018/pynab.svg?logo=lgtm&logoWidth=18&label=LGTM%20Alerts"/></a>
<a href="https://lgtm.com/projects/g/nabaztag2018/pynab/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/nabaztag2018/pynab.svg?logo=lgtm&logoWidth=18&label=LGTM%20Code%20Quality"/></a>
<a href="https://codecov.io/gh/nabaztag2018/pynab"><img src="https://codecov.io/gh/nabaztag2018/pynab/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://twitter.com/nabaztagtagtag"><img src="https://img.shields.io/twitter/follow/nabaztagtagtag?label=Follow&style=social" alt="Follow us in Twitter"></a>
<a href="https://dsc.gg/nabaztagtagtag"><img src="https://discordapp.com/api/guilds/872114025918513193/widget.png?style=shield" alt="Discord Server"></a>
</p>
<p align="center">
<a href="https://github.com/nabaztag2018/pynab/actions/workflows/python-lint.yml"><img src="https://github.com/nabaztag2018/pynab/actions/workflows/python-lint.yml/badge.svg?branch=master" alt="✔️ Python lint"></a>
<a href="https://github.com/nabaztag2018/pynab/actions/workflows/arm-runner.yml"><img src="https://github.com/nabaztag2018/pynab/actions/workflows/arm-runner.yml/badge.svg?branch=master" alt="🏗️ Build"></a>
<a href="https://github.com/nabaztag2018/pynab/actions/workflows/tests.yml"><img src="https://github.com/nabaztag2018/pynab/actions/workflows/tests.yml/badge.svg?branch=master" alt="🧪 Tests"></a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black"></a>
<a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
</p>

## Cartes

Expand Down

0 comments on commit 30d5772

Please sign in to comment.