mirror of https://github.com/Hilbis/Hilbish
Compare commits
3 Commits
9e253c739e
...
74a6eda0f3
Author | SHA1 | Date |
---|---|---|
TorchedSammy | 74a6eda0f3 | |
TorchedSammy | e5d8f88f46 | |
TorchedSammy | 101de3387e |
|
@ -1,10 +1,47 @@
|
|||
# Contributing
|
||||
# Contributing to Hilbish
|
||||
Thanks for your interest in contributing to Hilbish! No matter if it's
|
||||
a new feature, documentation, or bug report, we appreciate any kind
|
||||
of contributions.
|
||||
|
||||
## Pull Request Process
|
||||
This file is a document to state the steps/rules to take when making
|
||||
a contribution. Be sure to read through it.
|
||||
|
||||
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.
|
||||
## Bug Reports // Feature Requests
|
||||
Use GitHub Issues to report any bugs or to request any features
|
||||
that may be useful to *anyone* else.
|
||||
|
||||
Check [currently open issues](https://github.com/Hilbis/Hilbish/issues)
|
||||
and [closed ones](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aclosed) to make sure someone else hasn't already made the issue.
|
||||
|
||||
For bug reports, be sure to include:
|
||||
- Hilbish Version (`hilbish -v`)
|
||||
- Ways to reproduce
|
||||
|
||||
## Code
|
||||
For any code contributions (Lua and/or Go), you should follow these
|
||||
rules:
|
||||
- Tab size 4 indentation
|
||||
- In Lua prefer no braces `()` if the function takes 1 argument
|
||||
- Use camelCase for function names
|
||||
|
||||
### Making the Pull Request
|
||||
1. Ensure that any new install or build dependencies are documented in
|
||||
the README.md and PR request.
|
||||
|
||||
2. Say in the pull request details the 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.
|
||||
|
||||
4. Finally, make the pull request to the **dev** branch.
|
||||
|
||||
## Finding Issues to Contribute to
|
||||
You can check out the [help wanted](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+)
|
||||
labels to figure out what we need your help working on.
|
||||
|
||||
The [up for grabs](https://github.com/Hilbis/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+) labeled issues are low hanging fruit that should be
|
||||
easy for anyone. You can use this to get started on contributing!
|
||||
|
|
42
README.md
42
README.md
|
@ -1,11 +1,26 @@
|
|||
# Hilbish
|
||||
🎀 a nice lil shell for lua people made with go and lua
|
||||
<div align="center">
|
||||
<h1>Hilbish</h1>
|
||||
<blockquote>
|
||||
🎀 a nice lil shell for lua people made with go and lua
|
||||
</blockquote>
|
||||
</div>
|
||||
|
||||
It is currently in a mostly beta state but is very much usable
|
||||
(I'm using it right now).
|
||||
Hilbish is an interactive Unix-like shell written in Go, with the config
|
||||
and other code written in Lua.
|
||||
It is currently in a Beta state. Though very fit for daily usage,
|
||||
updates may contain breaking changes.
|
||||
|
||||
# Screenshots
|
||||
<div align="center">
|
||||
<img src="gallery/default.png"><br><br>
|
||||
<img src="gallery/terminal.png"><br><br>
|
||||
<img src="gallery/pillprompt.png">
|
||||
</div>
|
||||
|
||||
# Links
|
||||
- **[Documentation](https://github.com/Hilbis/Hilbish/wiki)**
|
||||
- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See
|
||||
more screenshots of Hilbish in action
|
||||
|
||||
# Building
|
||||
Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile.
|
||||
|
@ -51,5 +66,22 @@ yay -S hilbish
|
|||
sudo make uninstall
|
||||
```
|
||||
|
||||
# Contributing
|
||||
Any kind of contributions to Hilbish are welcome!
|
||||
Make sure to read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started.
|
||||
|
||||
### Special Thanks To
|
||||
Everyone here who has contributed:
|
||||
<a href="https://github.com/Hilbis/Hilbish/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" />
|
||||
</a>
|
||||
|
||||
*Made with [contributors-img](https://contrib.rocks).*
|
||||
|
||||
### Credits
|
||||
- [This blog post](https://www.vidarholen.net/contents/blog/?p=878) which
|
||||
is how Hilbish now inserts a newline even if output doesn't have one.
|
||||
|
||||
# License
|
||||
[MIT](LICENSE)
|
||||
Hilbish is licensed under the MIT license.
|
||||
[Read here](LICENSE) for more info.
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 8.1 KiB |
Binary file not shown.
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
After Width: | Height: | Size: 88 KiB |
Loading…
Reference in New Issue