Compare commits

...

3 Commits

Author SHA1 Message Date
TorchedSammy 9e253c739e chore: merge from dev 2021-04-08 10:34:03 -04:00
devins2518 3fd5fc8ac2
docs: update docs to reflect both aur versions (#33) 2021-04-08 10:29:48 -04:00
devins2518 2ecb4c66de
docs: added CONTRIBUTING.md and a pull request template (#32)
* docs: add CONTRIBUTING.md

* docs: add pull request template
2021-04-08 10:28:56 -04:00
3 changed files with 20 additions and 1 deletions

View File

@ -0,0 +1,5 @@
---
- [ ] I have reviewed CONTRIBUTING.md.
- [ ] My commits and title use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format.
- [ ] I have documented any breaking changes according to [SemVer](https://semver.org/).
---

10
CONTRIBUTING.md 100644
View File

@ -0,0 +1,10 @@
# Contributing
## Pull Request Process
1. Ensure that any new install or build dependencies are documented in the README.md and PR request.
2. Update the README.md with details of changes to the shell, this includes useful file locations
and breaking changes.
3. The versioning scheme we use is [SemVer](http://semver.org/) and the commit scheme we use is
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please document any
backwards incompatible changes and be sure to name your commits correctly.

View File

@ -37,10 +37,14 @@ sudo make install
sudo make all
```
Alternativly, if you use Arch Linux, you can install Hilbish with an **(unofficial)** AUR package
Alternativly, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package
```sh
yay -S hilbish-git
```
Or install a prebuilt binary from an **(unofficial)** AUR package
```sh
yay -S hilbish
```
### Uninstall
```sh