Skip to content

Commit

Permalink
Add contributing instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
numirias authored Dec 20, 2017
1 parent fdd42ec commit 6d5770c
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,34 @@ window.</td>
</table>
<!--commands-end-->

---
## Contributing

If you have found a bug or want to suggest a feature, please [file an issue](https://github.com/numirias/qtile-plasma/issues/new).


To work on Plasma locally, you need to clone submodules too, since the layout integration tests use some of Qtile's test fixtures:

```
git clone --recursive https://github.com/numirias/qtile-plasma/
```

Also make sure you meet the [hacking requirements of Qtile](http://docs.qtile.org/en/latest/manual/hacking.html). In particular, have `xserver-xephyr` installed. Then run:

```
make init
```

If that fails, run the `init` instructions from the [Makefile](https://github.com/numirias/qtile-plasma/blob/master/Makefile) one by one.

All new changes need to be fully test-covered and pass the linting:

```
make lint
make test
```

If you made changes to the layout API, also re-build this README's [commands](#commands) section:

```
make readme
```

0 comments on commit 6d5770c

Please sign in to comment.